Typos and doc updates

This commit is contained in:
QuantumEntangledAndy committed 2020-08-02 19:51:20 +07:00
1 parent 7de269d1b3
commit 8e2aa426a5
3 files changed
+35 -43

No files matched your search

+10 -14
View File
@@ -7,21 +7,21 @@ buster/stetch or any other os that uses systemd.
The general steps are:
1. Create an unprivileged user to run neolink
2. Setting up neolink somewhere the unprivileged user can run it
2. Set up neolink somewhere the unprivileged user can run it
3. Creating the service file
## Creating the unprivileged user
For this I will use the username neolinker. Any unused name would be fine.
```
```bash
sudo adduser --system --no-create-home --shell /bin/false neolinker
```
Depending on your flavour of linux `adduser` may have also created
a group of the same name. If it did not, you can create a group with:
```
```bash
sudo addgroup --system neolinker
```
@@ -31,7 +31,7 @@ For this we will put neolink in `/usr/local/bin` and the config in `/usr/local/e
We will also secure the config file so that only neolinker (and root) can read it. We want to do this because it contains passwords.
```
```bash
sudo cp neolink /usr/local/bin/neolink
sudo cp my_config.toml /usr/local/etc/neolink_config.toml
sudo chmod 755 /usr/local/bin/neolink
@@ -43,7 +43,7 @@ sudo chmod 600 /usr/local/etc/neolink_config.toml
We will create a systemd service. This service will need to point to our files for using neolink and also instruct it to start with our unprivileged user.
Create a file here `/etc/systemd/system/neolink.service` with the following contents:
Create a file here `/etc/systemd/system/neolink.service` with the following contents (you will need admin privileges to write to this location):
```
[Install]
@@ -69,34 +69,30 @@ You can now control the service with the usual commands
To start it use:
```
```bash
systemctl start neolink
```
To stop it use:
```
```bash
systemctl stop neolink
```
To check it's running use:
```
```bash
systemctl status neolink
```
To make it run at startup from now on:
```
```bash
systemctl enable neolink
```
You can check it's log file with
```
```bash
journalctl -xeu neolink
```