Skip to content

Commit a19b43a

Browse files
committed
chore: remove image warning from readme
1 parent fc72434 commit a19b43a

1 file changed

Lines changed: 2 additions & 8 deletions

File tree

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,16 @@ A simple server to transparently collect version information from Tinyauth insta
44

55
## How does it work
66

7-
Every Tinyauth instance runs a goroutine (unless you choose to opt-out) that does a "heartbeat" every 12 hours indicating the instance is still alive. The heartbeat contains the UUID generated by Tinyauth on start up and the version information. The server stores them in the SQLite database alongside with the last seen date. When you request all the instances, the server responds with an array containing the versions, UUIDs and last seen dates.
7+
Every Tinyauth instance runs a goroutine (unless you choose to opt-out) that does a "heartbeat" every 12 hours indicating the instance is still alive. The heartbeat contains the UUID generated by Tinyauth on start up and the version information. The server stores them in the SQLite database alongside with the last seen date. When you request all the instances, the server responds with an array containing the versions, UUIDs and last seen dates. In order to increase transparency, if the `LOG_LEVEL` is configured to `debug` or `trace`, the server will return a warning both in the instances and heartbeat endpoint in order to inform the user that sensitive information like IP addresses may be logged.
88

99
## Running
1010

11-
The central information server is hosted at `api.tinyauth.app/v1/` and all instance information can be requested from the `/v1/instances/all` endpoint. But, if you would like to run your own server for your own projects, you can by simply cloning the repository and running:
11+
The central information server is hosted at `https://api.tinyauth.app` and all instance information can be requested from the `/v1/instances/all` endpoint. But, if you like, you can run your own server for your own projects, you can do so by simply cloning the repository and running:
1212

1313
```sh
1414
docker compose up -d
1515
```
1616

17-
> [!NOTE]
18-
> Make sure to edit the environment variables to suit your needs.
19-
20-
> [!NOTE]
21-
> The docker compose file builds the image from scratch by default but there are also available prebuilt images in the packages section.
22-
2317
## Configuration
2418

2519
The server is configured using environment variables, the following options are supported:

0 commit comments

Comments
 (0)