diff --git a/manual/manual.epub b/manual/manual.epub index d59b6f6ab..a1bfaf2a4 100644 Binary files a/manual/manual.epub and b/manual/manual.epub differ diff --git a/manual/manual.html b/manual/manual.html index a1a196946..b8aeb7cc8 100644 --- a/manual/manual.html +++ b/manual/manual.html @@ -282,9 +282,16 @@ first account becomes the administrator.

the browser. However, you can receive notifications via email, XMPP, Matrix or ntfy.

-

Add the following to /etc/crontab.

+

Copy the notifications script:

# */1 * * * * root /opt/epicyon/scripts/epicyon-notification
+class="sourceCode bash">cp /opt/epicyon/scripts/epicyon-notification /usr/local/bin/epicyon-notification +chmod +x /usr/local/bin/epicyon-notification +

If you are using email for notifications and it is a single user +instance then you might want to edit MY_EMAIL_ADDRESS within +/usr/local/bin/epicyon-notification.

+

Then add the following to /etc/crontab.

+
# */1 * * * * root /usr/local/bin/epicyon-notification

Installing on Onion or i2p domains

If you don’t have access to the clearnet, or prefer to avoid it, then @@ -302,24 +309,24 @@ instances.

Unlike some other instance types, Epicyon is really easy to upgrade. It only requires a git pull to obtain the changes from the upstream repo, then set permissions and restart the daemon.

-
cd /opt/epicyon
-git pull
-chown -R epicyon:epicyon *
-systemctl restart epicyon
+
cd /opt/epicyon
+git pull
+chown -R epicyon:epicyon *
+systemctl restart epicyon

Housekeeping

To avoid running out of disk space you will want to clear down old inbox posts. Posts from your instance outboxes will be unaffected.

Create an archive script /usr/bin/epicyon-archive:

-
#!/bin/bash
-cd /opt/epicyon || exit 0
-/usr/bin/python3 epicyon.py --archive none --archiveweeks 4 --maxposts 32000
+
#!/bin/bash
+cd /opt/epicyon || exit 0
+/usr/bin/python3 epicyon.py --archive none --archiveweeks 4 --maxposts 32000

You can adjust the maximum number of weeks and the maximum number of inbox posts as needed. Then add it as a cron entry.

-
echo "*/60 * * * * root /usr/bin/epicyon-archive" >> /etc/crontab
+
echo "*/60 * * * * root /usr/bin/epicyon-archive" >> /etc/crontab

Registering accounts

You will notice that within the systemd daemon the registration option is set to open. In a browser if diff --git a/manual/manual.md b/manual/manual.md index 4635b4040..c4cd66ccd 100644 --- a/manual/manual.md +++ b/manual/manual.md @@ -248,10 +248,19 @@ Now you can navigate to your domain and register an account. The first account b ## Configuring notifications Since Epicyon does not use javascript there are no notifications in the browser. However, you can receive notifications via email, XMPP, [Matrix](https://matrix.org) or [ntfy](https://ntfy.sh). -Add the following to */etc/crontab*. +Copy the notifications script: ``` bash -# */1 * * * * root /opt/epicyon/scripts/epicyon-notification +cp /opt/epicyon/scripts/epicyon-notification /usr/local/bin/epicyon-notification +chmod +x /usr/local/bin/epicyon-notification +``` + +If you are using email for notifications and it is a single user instance then you might want to edit *MY_EMAIL_ADDRESS* within */usr/local/bin/epicyon-notification*. + +Then add the following to */etc/crontab*. + +``` bash +# */1 * * * * root /usr/local/bin/epicyon-notification ``` ## Installing on Onion or i2p domains