magmaus3/continuwuity
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

document modifying systemd unit if changing database path

Browse source 
Signed-off-by: strawberry <strawberry@puppygock.gay>
This commit is contained in:
strawberry 2024-12-11 18:22:51 -05:00
parent af08d3f7bd
commit 0740d7259a
No known key found for this signature in database
1 changed files with 20 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/deploying/generic.md
View file

@ -89,11 +89,25 @@ on the network level, consider something like NextDNS or Pi-Hole.
## Setting up a systemd service ## Setting up a systemd service
The systemd unit for conduwuit can be found Two example systemd units for conduwuit can be found
[here](../configuration/examples.md#example-systemd-unit-file). You may need to [on the configuration page](../configuration/examples.md#debian-systemd-unit-file).
change the `ExecStart=` path to where you placed the conduwuit binary. You may need to change the `ExecStart=` path to where you placed the conduwuit
binary if it is not `/usr/bin/conduwuit`.
On systems where rsyslog is used alongside journald (i.e. Red Hat-based distros and OpenSUSE), put `$EscapeControlCharactersOnReceive off` inside `/etc/rsyslog.conf` to allow color in logs. On systems where rsyslog is used alongside journald (i.e. Red Hat-based distros
and OpenSUSE), put `$EscapeControlCharactersOnReceive off` inside
`/etc/rsyslog.conf` to allow color in logs.
If you are using a different `database_path` other than the systemd unit
configured default `/var/lib/conduwuit`, you need to add your path to the
systemd unit's `ReadWritePaths=`. This can be done by either directly editing
`conduwuit.service` and reloading systemd, or running `systemctl edit conduwuit.service`
and entering the following:
```
[Service]
ReadWritePaths=/path/to/custom/database/path
```
## Creating the conduwuit configuration file ## Creating the conduwuit configuration file
@ -101,7 +115,8 @@ Now we need to create the conduwuit's config file in
`/etc/conduwuit/conduwuit.toml`. The example config can be found at `/etc/conduwuit/conduwuit.toml`. The example config can be found at
[conduwuit-example.toml](../configuration/examples.md). [conduwuit-example.toml](../configuration/examples.md).
**Please take a moment to read the config. You need to change at least the server name.** **Please take a moment to read the config. You need to change at least the
server name.**
RocksDB is the only supported database backend. RocksDB is the only supported database backend.