diff --git a/docs/QUICK_START_GUIDE.en.md b/docs/QUICK_START_GUIDE.en.md index 52ce66a..e140cf3 100644 --- a/docs/QUICK_START_GUIDE.en.md +++ b/docs/QUICK_START_GUIDE.en.md @@ -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 ```bash -nano /etc/telemt.toml +nano /etc/telemt/telemt.toml ``` 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 ```bash @@ -101,28 +113,38 @@ paste this Systemd Module ```bash [Unit] Description=Telemt -After=network.target +After=network-online.target +Wants=network-online.target [Service] Type=simple -WorkingDirectory=/bin -ExecStart=/bin/telemt /etc/telemt.toml +User=telemt +Group=telemt +WorkingDirectory=/opt/telemt +ExecStart=/bin/telemt /etc/telemt/telemt.toml Restart=on-failure LimitNOFILE=65536 +AmbientCapabilities=CAP_NET_BIND_SERVICE +CapabilityBoundingSet=CAP_NET_BIND_SERVICE +NoNewPrivileges=true [Install] WantedBy=multi-user.target ``` 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 curl -s http://127.0.0.1:9091/v1/users | jq ```