You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,18 +13,18 @@ Everyone can use this project to analyze newly created TLS certificates as they
13
13
## Motivation
14
14
15
15
From the moment I first found out about the certificate transparency logs, I was absolutely amazed by the great software of [Calidog](https://github.com/CaliDog/), which made the transparency log easier accessible for everyone.
16
-
Their software "Certstream" parses the log and provides it in an easy-to-use format: json.
16
+
Their software "Certstream" parses the log and provides it in an easy-to-use format: JSON.
17
17
18
18
After creating my first application that utilized the certstream server, I found that the hosted (demo) version of the server wasn't as reliable as I thought it would be.
19
-
I got disconnects and sometimes other errors. Eventually the provided server was still only thought to be **a demo**.
19
+
I got disconnects and sometimes other errors. Eventually, the provided server was still only thought to be **a demo**.
20
20
21
21
I quickly thought about running my own instance of certstream. But I didn't want to install Elixir/Erlang on my server. Sure, I could have used Docker, but on second thought, I was really into the idea of creating an alternative server written in Go.
22
22
23
23
"Why Go?", you might ask. Because it is a great language that compiles to native binaries on all major architectures and OSes. All the cool kids are using it right now.
24
24
25
25
## Getting started
26
26
27
-
Setting up an instance of the certstream server is simple. You can either download and compile the code yourself, or use one of the [precompiled binaries](https://github.com/d-Rickyy-b/certstream-server-go/releases).
27
+
Setting up an instance of the certstream server is straightforward. You can either download and compile the code yourself, or use one of the [precompiled binaries](https://github.com/d-Rickyy-b/certstream-server-go/releases).
28
28
29
29
### Docker
30
30
@@ -33,7 +33,8 @@ You can use it by running this command:
33
33
34
34
`docker run -d -v /path/to/config.yaml:/app/config.yaml -p 8080:8080 0rickyy0/certstream-server-go`
35
35
36
-
> ⚠️ If you don't mount your own config file, the default config (config.sample.yaml) will be used. For more details, check out the [wiki](https://github.com/d-Rickyy-b/certstream-server-go/wiki/Configuration).
36
+
> [!WARNING]
37
+
> If you don't mount your own config file, the default config (config.sample.yaml) will be used. For more details, check out the [wiki](https://github.com/d-Rickyy-b/certstream-server-go/wiki/Configuration).
37
38
38
39
## Connecting
39
40
@@ -56,7 +57,7 @@ Read more about ping/pong WebSocket messages in the [Mozilla Developer Docs](htt
56
57
57
58
### Performance
58
59
59
-
At idle (no clients connected), the server uses about **40 MB** of RAM, **14.5 Mbit/s** and **4-10% CPU** (Oracle Free Tier) on average while processing around **250-300 certificates per second**.
60
+
At idle (no clients connected), the server uses about **40 MB** of RAM, **14.5 Mbit/s** and **4–10% CPU** (Oracle Free Tier) on average while processing around **250–300 certificates per second**.
60
61
61
62
### Monitoring
62
63
@@ -67,7 +68,7 @@ For an in-depth guide on how to do this, please refer to the [wiki](https://gith
67
68
68
69
### Example
69
70
70
-
To receive a live example for any of the endpoints, just send an HTTP GET request to the endpoints with `/example.json` appended to the endpoint.
71
+
To receive a live example for any of the endpoints, send an HTTP GET request to the endpoints with `/example.json` appended to the endpoint.
71
72
For example: `/full-stream/example.json`. This shows the lite format of a certificate update.
0 commit comments