Skip to content

Commit 12911d1

Browse files
author
Anton Prokhorov
committed
Update docs
1 parent 11b5b4b commit 12911d1

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

docs/docs/install/server.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,15 @@ To do this, go to your domain registrar's control panel and add a new nameserver
2020
name `ns.<DOMAIN>` and the IP address `<PUBLIC_IP>`, then add an `NS` record for your `<DOMAIN>` pointing to
2121
the created nameserver, i.e. `ns.<DOMAIN>`.
2222

23-
2423
:::info
2524

2625
Let's say you have the domain `example.com` and a server with the public IP address `123.123.123.123`.
2726
In the registrar's control panel you must add a new nameserver `ns.example.com` with IP address `123.123.123.123`.
2827
Then, you need to add an `NS` record for `example.com`:
2928

30-
| example.com | record type | value |
31-
| - | - | - |
32-
| @ | NS | ns.example.com |
29+
| example.com | record type | value |
30+
| ----------- | ----------- | -------------- |
31+
| @ | NS | ns.example.com |
3332

3433
:::
3534

@@ -43,7 +42,6 @@ $ host -t a ns.<DOMAIN>
4342
ns.<DOMAIN> has address <PUBLIC_IP>
4443
```
4544

46-
4745
## Docker compose
4846

4947
The recommended way to install the Sonar backend on your server is to use a Docker Compose file.
@@ -55,15 +53,15 @@ services:
5553
restart: always
5654
image: ghcr.io/nt0xa/sonar:1
5755
ports:
58-
- 21:21 # FTP
59-
- 25:25 # SMTP
60-
- 53:53/udp # DNS
61-
- 80:80 # HTTP
62-
- 443:443 # HTTPS
56+
- 21:21 # FTP
57+
- 25:25 # SMTP
58+
- 53:53/udp # DNS
59+
- 80:80 # HTTP
60+
- 443:443 # HTTPS
6361
- 31337:31337 # REST API
64-
- 31338:31338 # Webhooks (currently only used by Lark messenger)
62+
- 31338:31338 # Webhooks (currently only used by Lark messenger in "webhook" mode)
6563
volumes:
66-
- ./tls:/opt/app/tls # TLS certificates persistance
64+
- ./tls:/opt/app/tls # TLS certificates persistance
6765
- ./config.yml:/opt/app/config.yml # Config file: see "Configuration"
6866

6967
db:
@@ -81,7 +79,7 @@ services:
8179
8280
To configure the Sonar backend create a `config.toml` file in the same directory as the `docker-compose.yml` file.
8381

84-
```toml title="config.toml"
82+
```toml title="config.toml"
8583
# Your server public IP address.
8684
ip = "<PUBLIC_IP>"
8785
@@ -132,7 +130,7 @@ admin = "<TOKEN>"
132130
# Telegram configuration.
133131
[modules.telegram]
134132
# Admin user Telegram ID. Use @getmyid_bot to get yours.
135-
admin = <USER_ID>
133+
admin = "<USER_ID>"
136134
# Bot token. Use @BotFather bot to get one.
137135
token = "<BOT_TOKEN>"
138136

@@ -143,7 +141,11 @@ admin = "<ADMIN_ID>"
143141
app_id = "<APP_ID>"
144142
# App Secret. You can find it on the "Credentials & Basic Info" page of your app.
145143
app_secret = "<APP_SECRET>"
146-
# Verification token. You can find it on the "Events & callbacks" page of your app
144+
# Mode. There are two moded supported "webhook" (default) and "websocket".
145+
# See https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/handle-events
146+
# for more information.
147+
mode = "webhook"
148+
# Verification token. Required only for "webhook" mode. You can find it on the "Events & callbacks" page of your app
147149
# under the "Encryption strategy" tab.
148150
verification_token = "<VERIFICATION_TOKEN>"
149151
```

0 commit comments

Comments
 (0)