astelm
/
telemt
mirror of https://github.com/telemt/telemt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix config path and update service creation steps 

Updated paths and instructions in the quick start guide for Telemt configuration and service setup.
This commit is contained in:
Denis Shulyaka 2026-03-09 19:38:55 +03:00 committed by GitHub
parent f4418d2d50
commit c920dc6381
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 32 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/QUICK_START_GUIDE.en.md
View File

@ -48,11 +48,16 @@ Save the obtained result somewhere. You will need it later!
--- ---
**1. Place your config to /etc/telemt.toml** **1. Place your config to /etc/telemt/telemt.toml**
Create config directory:
```bash
mkdir /etc/telemt
```
Open nano Open nano
```bash ```bash
nano /etc/telemt.toml nano /etc/telemt/telemt.toml
``` ```
paste your config paste your config
@ -90,7 +95,14 @@ then Ctrl+S -> Ctrl+X to save
--- ---
**2. Create service on /etc/systemd/system/telemt.service** **2. Create telemt user**
```bash
useradd -d /opt/telemt -m -r -U telemt
chown -R telemt:telemt /etc/telemt
```
**3. Create service on /etc/systemd/system/telemt.service**
Open nano Open nano
```bash ```bash
@ -101,28 +113,38 @@ paste this Systemd Module
```bash ```bash
[Unit] [Unit]
Description=Telemt Description=Telemt
After=network.target After=network-online.target
Wants=network-online.target
[Service] [Service]
Type=simple Type=simple
WorkingDirectory=/bin User=telemt
ExecStart=/bin/telemt /etc/telemt.toml Group=telemt
WorkingDirectory=/opt/telemt
ExecStart=/bin/telemt /etc/telemt/telemt.toml
Restart=on-failure Restart=on-failure
LimitNOFILE=65536 LimitNOFILE=65536
AmbientCapabilities=CAP_NET_BIND_SERVICE
CapabilityBoundingSet=CAP_NET_BIND_SERVICE
NoNewPrivileges=true
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
then Ctrl+S -> Ctrl+X to save then Ctrl+S -> Ctrl+X to save
reload systemd units
```bash
systemctl daemon-reload
```
**3.** To start it, enter the command `systemctl start telemt` **4.** To start it, enter the command `systemctl start telemt`
**4.** To get status information, enter `systemctl status telemt` **5.** To get status information, enter `systemctl status telemt`
**5.** For automatic startup at system boot, enter `systemctl enable telemt` **6.** For automatic startup at system boot, enter `systemctl enable telemt`
**6.** To get the link(s), enter **7.** To get the link(s), enter
```bash ```bash
curl -s http://127.0.0.1:9091/v1/users | jq curl -s http://127.0.0.1:9091/v1/users | jq
``` ```