Alpine Linux - User contributions [en]

Configure a Wireguard interface (wg)

2026-02-18T20:30:27Z

Jahway603: Added chmod go= for private key

{{TOC right}}

[https://en.wikipedia.org/wiki/WireGuard WireGuard] multiple platform vpn solution. WireGuard itself is now integrated into the linux kernel since v5.6. Only the userland configuration tools are required.

== Installation ==

The most straightforward method to configure WireGuard is to use the tool <code>wg-quick</code> available in the package {{pkg|wireguard-tools-wg-quick}}.

Install the meta package {{pkg|wireguard-tools}} to install the necessary WireGuard packages and {{pkg|iptables}} as follows: {{Cmd|# apk add wireguard-tools iptables}}

== Configuration ==

=== Create Server Keys and Interface Config ===

Create a server private and public key: {{Cmd|<nowiki># wg genkey | tee server.privatekey | wg pubkey > server.publickey</nowiki>}}

Remove any permissions on the file for users and groups other than the root user to ensure that only it can access the private key: {{Cmd|<nowiki># chmod go= server.privatekey</nowiki>}}

Then, we create a new config file {{Path|/etc/wireguard/wg0.conf}} using these new keys as follows:{{Cat|/etc/wireguard/wg0.conf|<nowiki>
[Interface]
Address = 192.168.2.1/24, fddd::ffff/64
ListenPort = 45340
PrivateKey = <server private key value> # the key from the previously generated privatekey file
PostUp = iptables -A FORWARD -i %i -j ACCEPT; iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE;iptables -A FORWARD -o %i -j ACCEPT; ip6tables -A FORWARD -i %i -j ACCEPT; ip6tables -t nat -A POSTROUTING -o eth0 -j MASQUERADE;ip6tables -A FORWARD -o %i -j ACCEPT
PostDown = iptables -D FORWARD -i %i -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE;iptables -D FORWARD -o %i -j ACCEPT; ip6tables -D FORWARD -i %i -j ACCEPT; ip6tables -t nat -D POSTROUTING -o eth0 -j MASQUERADE;ip6tables -D FORWARD -o %i -j ACCEPT

[Peer]
PublicKey = <client public key value> # obtained from client device via wireguard connection setup process
AllowedIPs = 192.168.2.2/32, fddd::1/128</nowiki>}}

The PostUp and PostDown iptable rules forward traffic from the wg0 subnet (192.168.2.1/24) to the lan subnet on interface eth0. Refer to [https://github.com/pirate/wireguard-docs#user-content-config-reference this WireGuard documentation] for information on adding peers to the config file.

Bring up the new {{ic|wg0}} interface:{{Cmd|# wg-quick up wg0}}

To take it down, we can use <code>wg-quick down wg0</code> which will clean up the interface and remove the iptables rules.

{{Note|If running in a Docker container, you will need to run with <code>--cap-add{{=}}NET_ADMIN</code> to modify your interfaces.}}

=== Use with network interfaces ===

To enable connecting with Wireguard on boot, open your {{Path|/etc/network/interfaces}} and add this information after your auto other network interfaces as follows:{{Cat|/etc/network/interfaces|<nowiki>...
auto wg0
iface wg0 inet static
pre-up wg-quick up /etc/wireguard/wg0.conf</nowiki>}}

=== Service configuration ===

Since Alpine 3.20, {{pkg|wireguard-tools-openrc}} package provides an OpenRC initd service file.

To use this, install the package:{{Cmd|# apk add wireguard-tools-openrc }}

To use the WireGuard OpenRC script with {{ic|wg-quick.wg0}}, create a symbolic link to it with the configuration name as follows:{{Cmd|# ln -s /etc/init.d/wg-quick /etc/init.d/wg-quick.wg0}}

Add the {{ic|wg-quick.wg0}} service to the default runlevel:{{Cmd|# rc-update add wg-quick.wg0}}
To start|stop|restart the [[OpenRC]] service:{{Cmd|# rc-service wg-quick.wg0 start}}

=== Enable IP Forwarding ===

With a NAT destination rule in place on your router, you should be able connect to the wireguard instance and access the host. However, if you intend for peers to be able to access external resources (including the internet), you will need to enable ip forwarding.

Edit the file {{Path|/etc/sysctl.conf}} or a <code>.conf</code> file under {{Path|/etc/sysctl.d/}} folder add the following line as follows:{{Cat|/etc/sysctl.conf|
net.ipv4.ip_forward {{=}} 1
net.ipv6.conf.all.forwarding {{=}} 1
net.ipv6.conf.default.forwarding {{=}} 1}}

Add the sysctl service to run at boot:{{Cmd|# rc-update add sysctl}}

Then either reboot or run {{ic|# sysctl -p /etc/sysctl.conf}} to reload the settings. To ensure forwarding is turned on, run {{ic|# sysctl -a | grep ip_forward}} and ensure <Code>net.ipv4.ip_forward</code> is set to <code>1</code>.

In the file {{Path|/etc/conf.d/iptables}}, Change the setting as follows:{{Cat|/etc/conf.d/iptables|...
IPFORWARD{{=}}"yes"}}

== Running with modloop ==

If you are running [[Diskless Mode]] i.e from a RAM disk, you can't modify the modloop.

You can get around it by unpacking the modloop, mounting the unpacked modules folder, then installing WireGuard.

#!/bin/sh
apk add squashfs-tools # install squashfs tools to unpack modloop
unsquashfs -d /root/squash /lib/modloop-lts # unpack modloop to root dir
umount /.modloop # unmount existing modloop
mount /root/squash/ /.modloop/ # mount unpacked modloop
apk del wireguard-lts # uninstall previous WireGuard install
apk add wireguard-lts
apk add wireguard-tools

You can repack the squash filesystem or put this script in the /etc/local.d/ path so it runs at boot-up.

== Preventing leaks ==

When using a private network over Wireguard, it may be desirable to prevent traffic from leaking onto other networks with the same range (e.g.: a Wi-Fi network using the same range).

Suppose we are using the network <code>fd00:feed:c0de::</code> over Wireguard. To prevent leaks using [[nftables]], use the following <code>/etc/nftables.d/private-network.nft</code>:

#!/usr/sbin/nft -f

table inet filter {
chain output {
type filter hook output priority 0;

# Allow traffic to fd00:feed:c0de::1 only via wg0.
ip6 daddr fd00:feed:c0de::1 oifname "wg0" accept

# Drop all other attempts to reach fd00:feed:c0de::1.
ip6 daddr fd00:feed:c0de::1 drop
}
}

== See also ==

* [https://github.com/pirate/wireguard-docs WireGuard documentation]

[[Category:Networking]]

Postgresql

2025-11-03T16:00:29Z

Jahway603: /* Installation */ removed postgresql 14, as not available in v3.22

PostgreSQL is a well known opensource database that scales well and is easy to use.

== Installation ==

PostgreSQL 17 is the latest version since [[Release_Notes_for_Alpine_3.21.0#PostgreSQL_17|v3.21]].

To install PostgreSQL 17,
{{Cmd|# apk add postgresql17 postgresql17-contrib postgresql17-openrc}}
{{Cmd|# rc-update add postgresql}}
{{Cmd|# rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called '''postgres'''.

Older versions of PostgreSQL 16 and PostgreSQL 15 are still available as of [[Release Notes for Alpine 3.22.0|v3.22]] and can be installed using the same commands as above except for replacing the version number in the appropriate package names. For example, {{pkg|postgresql17}} is to be replaced by {{pkg|postgresql16}} and {{pkg|postgresql15}} for PostgreSQL 16 and PostgreSQL 15 14 respectively.

== Configuration ==

Login as the postgres user and start psql to create a new user and database:
{{Cmd|su postgres}}
{{Cmd|psql}}
{{Cmd|create user user with encrypted password 'password';}}
{{Cmd|create database database;}}
{{Cmd|grant all privileges on database database to user;}}

=== Network access ===

By default only local access is allowed to PostgreSQL. To allow other networked services to access the database we need to configure PostgreSQL to allow external connections.

In this example, we are using PostgreSQL v16, so substitute below for your specific version.
Edit the {{Path|/etc/postgresql16/postgresql.conf}} file using <code>nano</code> or any other {{ic|<editor> /etc/postgresql16/postgresql.conf}}
Find the line that starts with <pre>#listen_addresses = 'localhost'</pre>
Uncomment it and change it to the following:
<pre>listen_addresses = '*'</pre>
If you want it to listen on a specific ip you can change * to 192.168.1.2/24.
Save the file and change the next config file.

Modify the {{Path|/etc/postgresql16/pg_hba.conf}} file using <code>nano</code> or any other {{ic|<editor> /etc/postgresql16/pg_hba.conf}}
Look for the line: <pre>host all all 127.0.0.1/32 md5</pre>
And change it to: <pre>host all all 0.0.0.0/0 md5</pre>
This line allows connections from any IP address and requires a password for authentication (md5).
Restart the server to allow incoming connections from other hosts. {{Cmd|rc-service postgresql restart}}

Allow the port through the firewall. For [[UFW]] firewall type: {{Cmd|ufw allow 5432}}

This is a basic configuration. You can configure the PostgreSQL server to only allow certain networks or IP's to connect, but that's beyond the scope of this documentation.

== Switching between PostgreSQL versions ==

On Alpine Linux, you can use the command `pg_versions` to switch between PostgreSQL versions. This is very helpful when upgrading the version you are using.

== Upgrading PostgreSQL ==

Please follow along with [https://perrotta.dev/2025/05/postgresql-major-version-upgrade-on-alpine-linux/ this guide] and adjust the version you are moving from and the version you are upgrading to.

There's also [https://beune.dev/posts/upgrade-alpine-postgresql/ this].

== See also ==
* [https://blog.devart.com/configure-postgresql-to-allow-remote-connection.html Guide for Upgrading PostgreSQL]
* [https://beune.dev/posts/upgrade-alpine-postgresql/ older postgresql upgrade guide]

[[Category:Database]]
[[Category:Server]]

Postgresql

2025-10-31T13:20:08Z

Jahway603: Added Configuration section

PostgreSQL is a well known opensource database that scales well and is easy to use.

== PostgreSQL 17 Installation ==

To install PostgreSQL 17,
{{Cmd|apk add postgresql17 postgresql17-contrib postgresql17-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

== PostgreSQL 16 Installation ==

To install PostgreSQL 16,
{{Cmd|apk add postgresql16 postgresql16-contrib postgresql16-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

== PostgreSQL 15 Installation ==

To install PostgreSQL 15,
{{Cmd|apk add postgresql15 postgresql15-contrib postgresql15-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

== PostgreSQL 14 Installation ==

To install PostgreSQL 14,
{{Cmd|apk add postgresql14 postgresql14-contrib postgresql14-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

== Configuration ==

Login as the postgres user and start psql to create a new user and database:
{{Cmd|su postgres}}
{{Cmd|psql}}
{{Cmd|create user user with encrypted password 'password';}}
{{Cmd|create database database;}}
{{Cmd|grant all privileges on database database to user;}}

=== Network access ===

By default only local access is allowed to PostgreSQL. To allow other networked services to access the database we need to configure PostgreSQL to allow external connections.

In this example, we are using PostgreSQL v16, so substitute below for your specific version.
Edit the {{Path|/etc/postgresql16/postgresql.conf}} file using <code>nano</code> or any other {{ic|<editor> /etc/postgresql16/postgresql.conf}}
Find the line that starts with <pre>#listen_addresses = 'localhost'</pre>
Uncomment it and change it to the following:
<pre>listen_addresses = '*'</pre>
If you want it to listen on a specific ip you can change * to 192.168.1.2/24.
Save the file and change the next config file.

Modify the {{Path|/etc/postgresql16/pg_hba.conf}} file using <code>nano</code> or any other {{ic|<editor> /etc/postgresql16/pg_hba.conf}}
Look for the line: <pre>host all all 127.0.0.1/32 md5</pre>
And change it to: <pre>host all all 0.0.0.0/0 md5</pre>
This line allows connections from any IP address and requires a password for authentication (md5).
Restart the server to allow incoming connections from other hosts. {{Cmd|rc-service postgresql restart}}

Allow the port through the firewall. For [[UFW]] firewall type: {{Cmd|ufw allow 5432}}

This is a basic configuration. You can configure the PostgreSQL server to only allow certain networks or IP's to connect, but that's beyond the scope of this documentation.

== Switching between PostgreSQL versions ==

On Alpine Linux, you can use the command `pg_versions` to switch between PostgreSQL versions. This is very helpful when upgrading the version you are using.

== Upgrading PostgreSQL ==

Please follow along with [https://perrotta.dev/2025/05/postgresql-major-version-upgrade-on-alpine-linux/ this guide] and adjust the version you are moving from and the version you are upgrading to.

There's also [https://beune.dev/posts/upgrade-alpine-postgresql/ this older guide].

== See also ==
* https://blog.devart.com/configure-postgresql-to-allow-remote-connection.html

[[Category:Database]]

[[Category:Server]]

Postgresql

2025-10-31T13:03:08Z

Jahway603: More generalization

PostgreSQL is a well known opensource database that scales well and is easy to use.

== PostgreSQL 17 ==

To install PostgreSQL 17,
{{Cmd|apk add postgresql17 postgresql17-contrib postgresql17-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== PostgreSQL 16 ==

To install PostgreSQL 16,
{{Cmd|apk add postgresql16 postgresql16-contrib postgresql16-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL 16, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page].

== PostgreSQL 15 ==

To install PostgreSQL 15,
{{Cmd|apk add postgresql15 postgresql15-contrib postgresql15-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== PostgreSQL 14 ==

To install PostgreSQL 14,
{{Cmd|apk add postgresql14 postgresql14-contrib postgresql14-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== Switching between PostgreSQL versions ==

On Alpine Linux, you can use the command `pg_versions` to switch between PostgreSQL versions. This is very helpful when upgrading the version you are using.

== Upgrading PostgreSQL ==

Please follow along with [https://perrotta.dev/2025/05/postgresql-major-version-upgrade-on-alpine-linux/ this guide] and adjust the version you are moving from and the version you are upgrading to.

There's also [https://beune.dev/posts/upgrade-alpine-postgresql/ this older guide].

[[Category:Database]]

Postgresql

2025-10-31T13:00:39Z

Jahway603: Better generalize certain sections

PostgreSQL is a well known opensource database that scales well and is easy to use.

== PostgreSQL 17 ==

To install PostgreSQL 17,
{{Cmd|apk add postgresql17 postgresql17-contrib postgresql17-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To install, configure, and use PostgreSQL 17, which is the latest release as of Alpine v3.21, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page]. It will also create a system user called postgres.

== PostgreSQL 16 ==

To install PostgreSQL 16,
{{Cmd|apk add postgresql16 postgresql16-contrib postgresql16-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To install, configure, and use PostgreSQL 16, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page]. It will also create a system user called postgres.

== PostgreSQL 15 ==

To install PostgreSQL 15,
{{Cmd|apk add postgresql15 postgresql15-contrib postgresql15-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== PostgreSQL 14 ==

To install PostgreSQL 14,
{{Cmd|apk add postgresql14 postgresql14-contrib postgresql14-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== Switching between PostgreSQL versions ==

On Alpine Linux, you can use the command `pg_versions` to switch between PostgreSQL versions. This is very helpful when upgrading the version you are using.

== Upgrading PostgreSQL ==

Please follow along with [https://perrotta.dev/2025/05/postgresql-major-version-upgrade-on-alpine-linux/ this guide] and adjust the version you are moving from and the version you are upgrading to.

There's also [https://beune.dev/posts/upgrade-alpine-postgresql/ this older guide].

[[Category:Database]]

Postgresql

2025-10-31T12:59:35Z

Jahway603: Added PostgreSQL 17 section

PostgreSQL is a well known opensource database that scales well and is easy to use.

== PostgreSQL 17 ==

To install PostgreSQL 17,
{{Cmd|apk add postgresql17 postgresql17-contrib postgresql17-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql 15 server and perform some initial configuration. It will also create a system user called postgres.

To install, configure, and use PostgreSQL 17, which is the latest release as of Alpine v3.21, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page]. It will also create a system user called postgres.

== PostgreSQL 16 ==

To install PostgreSQL 16,
{{Cmd|apk add postgresql16 postgresql16-contrib postgresql16-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

To install, configure, and use PostgreSQL 16, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page]. It will also create a system user called postgres.

== PostgreSQL 15 ==

To install PostgreSQL 15,
{{Cmd|apk add postgresql15 postgresql15-contrib postgresql15-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql 15 server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== PostgreSQL 14 ==

To install PostgreSQL 14,
{{Cmd|apk add postgresql14 postgresql14-contrib postgresql14-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql 14 server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== Switching between PostgreSQL versions ==

On Alpine Linux, you can use the command `pg_versions` to switch between PostgreSQL versions. This is very helpful when upgrading the version you are using.

== Upgrading PostgreSQL ==

Please follow along with [https://perrotta.dev/2025/05/postgresql-major-version-upgrade-on-alpine-linux/ this guide] and adjust the version you are moving from and the version you are upgrading to.

There's also [https://beune.dev/posts/upgrade-alpine-postgresql/ this older guide].

[[Category:Database]]

Nextcloud

2025-05-20T15:11:17Z

Jahway603: /* Nextcloud CLI occ */ added recent nextcloud-occ package install info

[https://nextcloud.com/ Nextcloud] is WedDAV-based solution for storing and sharing on-line your data, files, images, video, music, calendars and contacts. [https://karlitschek.de/2016/06/nextcloud/ Nextcloud is a fork of ownCloud with enterprise features included].

= Installation =
{{pkg|nextcloud}} is available in Alpine 3.5 and greater.

Before you start installing anything, make sure you have the latest packages available. Make sure you are using an 'http' repository in your {{path|/etc/apk/repositories}} file, then:
{{cmd|apk update}}
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

== Database ==
First you have to decide which database to use. Use one of the databases listed below.

=== Sqlite ===
All you need to do is to install the package:
{{cmd|apk add nextcloud-sqlite}}

=== PostgreSQL ===
Install the package:
{{cmd|apk add nextcloud-pgsql postgresql postgresql-client}}

Next thing is to configure and start the database:
{{cmd|rc-service postgresql setup
rc-service postgresql start}}

Next, you need to create a user and temporarily grant the CREATEDB privilege:
{{cmd|psql -U postgres
CREATE USER mycloud WITH PASSWORD 'test123';
ALTER ROLE mycloud CREATEDB;
\q}}
{{Note|Replace the above username 'mycloud' and password 'test123' with something secure. Remember these settings. You will need them later when setting up nextcloud.}}

Set postgresql to start on boot/:
{{cmd|rc-update add postgresql}}

=== MariaDB ===
Install the package:
{{cmd|apk add nextcloud-mysql mariadb mariadb-client}}

Now configure and start {{pkg|mariadb}}:
{{cmd|<nowiki>mariadb-install-db --user=mysql --datadir=/var/lib/mysql</nowiki>
service mariadb start
rc-update add mariadb
mariadb-secure-installation}}
Follow the wizard to setup passwords, etc.
{{Note|Remember the usernames/passwords that you set using the wizard. You will need them later.}}

Next, you need to create a user and database and set permissions:
{{cmd|mariadb -u root -p
CREATE DATABASE nextcloud;
GRANT ALL ON nextcloud.* TO 'mycloud'@'localhost' IDENTIFIED BY 'test123';
GRANT ALL ON nextcloud.* TO 'mycloud'@'localhost.localdomain' IDENTIFIED BY 'test123';
FLUSH PRIVILEGES;
EXIT}}
{{Note|Replace the above username 'mycloud' and password 'test123' with something secure. Remember these settings. You will need them later when setting up nextcloud.}}

{{pkg|mariadb-client}} is not needed anymore. Let's uninstall it:
{{cmd|apk del mariadb-client}}

== Webserver ==
Next thing is to choose, install, and configure a webserver. In this example we will install {{pkg|nginx}} or {{pkg|lighttpd}}. You are free to install any other webserver of your choice as long as it supports PHP and FastCGI. Generating an SSL certificate for your webserver is outside of the scope of this document.

{{pkg|nextcloud-initscript}} facilitates running the webserver with php-fpm.

{{cmd|apk add nextcloud-initscript}}

=== Nginx ===
Install the needed packages:
{{cmd|apk add nginx}}

Delete the default nginx website configuration:
{{cmd|rm /etc/nginx/http.d/default.conf}}

Create a configuration file for your site in {{path|/etc/nginx/http.d/mysite.mydomain.com.conf}}:
{{Cat|/etc/nginx/http.d/mysite.mydomain.com.conf|server {
#listen [::]:80; #uncomment for IPv6 support
listen 80;
return 301 https://$host$request_uri;
server_name mysite.mydomain.com;
}

server {
#listen [::]:443 ssl; #uncomment for IPv6 support
listen 443 ssl;
server_name mysite.mydomain.com;

root /usr/share/webapps/nextcloud;
index index.php index.html index.htm;
disable_symlinks off;

ssl_certificate /etc/ssl/cert.pem;
ssl_certificate_key /etc/ssl/key.pem;
ssl_session_timeout 5m;

#Enable Perfect Forward Secrecy and ciphers without known vulnerabilities
#Beware! It breaks compatibility with older OS and browsers (e.g. Windows XP, Android 2.x, etc.)
#ssl_ciphers ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA;
#ssl_prefer_server_ciphers on;

location / {
try_files $uri $uri/ /index.html;
}

# pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}
#fastcgi_pass 127.0.0.1:9000;
#fastcgi_pass unix:/run/php-fpm/socket;
fastcgi_pass unix:/run/nextcloud/fastcgi.sock; # From the nextcloud-initscript package
fastcgi_index index.php;
include fastcgi.conf;
}

# Help pass nextcloud's configuration checks after install:
# Per https://docs.nextcloud.com/server/22/admin_manual/issues/general_troubleshooting.html#service-discovery
location ^~ /.well-known/carddav { return 301 /remote.php/dav/; }
location ^~ /.well-known/caldav { return 301 /remote.php/dav/; }
location ^~ /.well-known/webfinger { return 301 /index.php/.well-known/webfinger; }
location ^~ /.well-known/nodeinfo { return 301 /index.php/.well-known/nodeinfo; }

include mime.types;
types {
text/javascript mjs;
}

}
}}

If you plan to enable uploads - and you probably do) - then you need to modify the default:
<pre>
client_max_body_size 1m;'
</pre>
setting in {{path|/etc/nginx/nginx.conf}}. For testing purposes, I disabled the limit by changing it to:

<pre>
client_max_body_size 0;
</pre>

This enabled large file uploads and auto-uploads to work. Note, this is a file-size restriction in addition to the restriction set in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}. That second restriction defaults to:

<pre>
; Maximal size of a file that can be uploaded via web interface.
php_admin_value[memory_limit] = 512M
php_admin_value[post_max_size] = 513M
php_admin_value[upload_max_filesize] = 513M
</pre>

Another setting that may limit file-size is in configuration file {{path|/etc/php81/php.ini}}, where I set the restriction to to:
<pre>
upload_max_filesize = 513M
</pre>
to match the {{path|/etc/php81/php-fpm.d/nextcloud.conf}} file-size restriction.

If you are running from RAM and you're dealing with large files you might need to move the FastCGI temp file from {{path|/tmp}} to {{path|/var/tmp}} or to a directory that is mounted on hdd:
<pre>
fastcgi_temp_path /var/tmp/nginx/fastcgi 1 2;
</pre>

Large file uploads take some time to be processed by php-fpm, so you need to bump the Nginx default read timeout:

<pre>
fastcgi_read_timeout 300s;
</pre>

{{Note|If you are serving several users make sure to tune the *''pm.max_children'' setting in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}}}

{{path|/etc/nginx/nginx.conf}} should already be configured to load your site config from this directory:
<pre>
...
# Includes virtual hosts configs.
include /etc/nginx/http.d/*;
...
</pre>

Start services:
{{cmd|service nginx start
service nextcloud start}}

Enable automatic startup of services:
{{cmd|rc-update add nginx
rc-update add nextcloud}}

=== Lighttpd ===
Install the package:
{{cmd|apk add lighttpd php5-cgi}}

Make sure you have FastCGI enabled in {{pkg|lighttpd}}:
{{cat|/etc/lighttpd/lighttpd.conf|...
include "mod_fastcgi.conf"
...}}

Start up the webserver:
{{cmd|rc-service lighttpd start}}

{{tip|You might want to follow the [[Lighttpd_Advanced_security#Https_access|Lighttpd_Https_access]] doc in order to configure lighttpd to use https ''(securing your connections to your nextcloud server)''.}}

Link {{pkg|nextcloud}} installation to web server directory:
{{cmd|ln -s /usr/share/webapps/nextcloud /var/www/localhost/htdocs}}

== Firewall ==
Next up, open the desired port for the webserver in the firewall. You can use the following snippet as a reference for an nftable rule in a new file{{path|/etc/nftables.d/50-https.nft}}:
{{Cat|/etc/nftables.d/50-https.nft|
#!/usr/sbin/nft -f

table inet filter {
chain input {
# allow https
tcp dport 443 accept comment "accept HTTPS"
}
}
}}

== Other settings ==
=== Hardening ===
Consider updating the variable <code>url.access-deny</code> in {{path|/etc/lighttpd/lighttpd.conf}} for additional security. Add <code>"config.php"</code> to the variable ''(that's where the database is stored)'' so it looks something like this:
{{cat|/etc/lighttpd/lighttpd.conf|...
url.access-deny {{=}} ("~", ".inc", "config.php")
...}}
Restart {{pkg|lighttpd}} to activate the changes:
{{cmd|rc-service lighttpd restart}}

=== Additional packages ===
Some large apps, such as pdfviewer, texteditor, notifications and videoplayer are in separate packages:
{{cmd|apk add nextcloud-files_pdfviewer nextcloud-text nextcloud-notifications nextcloud-files_videoplayer nextcloud-files_external}}
You can also install the {{pkg|nextcloud-default-apps}} meta-package which installs all 30 core Nextcloud apps (listed as dependencies under aforementioned link):
{{cmd|apk add nextcloud-default-apps}}

=== How To Create a Self-Signed SSL Certificate ===
Install openssl:
{{cmd|apk add openssl}}
Generate your self signed certificate and its private key:
{{cmd|<nowiki>openssl req -x509 -nodes -days 365 -newkey rsa:4096 -keyout /etc/ssl1.1/private/nextcloud-selfsigned.key -out /etc/ssl1.1/certs/nextcloud-selfsigned.crt</nowiki>}}
Edit your nginx configuration:
{{cat|/etc/nginx/http.d/mysite.mydomain.com.conf|
ssl_certificate /etc/ssl1.1/certs/nextcloud-selfsigned.crt;
ssl_certificate_key /etc/ssl1.1/private/nextcloud-selfsigned.key;
}}

=== How To Install and Set Up Auto-Renewing LetsEncrypt SSL Certificate ===
After first setting up the Nextcloud server using the instructions in the 'Configure and use Nextcloud' section below, I then followed the SSL-setup instructions at: [[https://techjogging.com/create-letsencrypt-certificate-alpine-nginx.html Tech Jogging]].

I also had to add my Nextcloud servers Fully Qualified Domain Name (FQDN) to the list of trusted domains in /etc/nextcloud/config.php. In the section labelled: 'trusted_domains':

<pre>
'trusted_domains' =>
array (
0 => '<machine's local IP address>',
1 => 'nextcloud.mydomain.com',
),
}}
</pre>

= Configure and use Nextcloud =

== Configure ==
Point your browser at <code><nowiki>https://mysite.mydomain.com</nowiki></code> and follow the on-screen instructions to complete the installation, supplying the database user and password created before.

== Hardening PostgreSQL ==
If you have chosen PGSQL backend, revoke CREATEDB privilege from 'mycloud' user:
{{cmd|psql -U postgres
ALTER ROLE mycloud NOCREATEDB;
\q}}

== Increase upload size ==
{{path|/etc/php81/php-fpm.d/nextcloud.conf}} has overridden default file sizes, but they can be modified further to suit your needs:
<pre>
; Maximal size of a file that can be uploaded via web interface.
php_admin_value[memory_limit] = 512M
php_admin_value[post_max_size] = 513M
php_admin_value[upload_max_filesize] = 513M
</pre>

== Enable opcache for nginx/php81 ==
To increase performace install
{{cmd|apk add php81-opcache}}

Now uncomment/edit lines in /etc/php81/php.ini:
<pre>
...
opcache.enable=1
opcache.enable_cli=1
opcache.interned_strings_buffer=8
opcache.max_accelerated_files=10000
opcache.memory_consumption=128 //you can reduce this slightly when short on RAM
opcache.save_comments=1
opcache.revalidate_freq=1
...
</pre>

Restart php-fpm81
{{cmd|rc-service php-fpm81 restart}}

== Enable thumbnail for video ==

To be able to generate thumbnails for videos, besides [https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/previews_configuration.html configuring] nextcloud, you will need to unlist <code>proc_open</code> from php's disabled functions. PHP relies on that function to call ffmpeg to generate the thumbnails, without that it will fail to do so even if you have it enabled on config.php.

Remove <code>proc_open</code> from the disabled function in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}:

<pre>
; Disable certain functions for security reasons.
; http://php.net/disable-functions
php_admin_value[disable_functions] = exec,passthru,shell_exec,system,curl_multi_exec,show_source
</pre>

Now add <code>'OC\\Preview\\Movie'</code> to the list of <code>'enabledPreviewProviders'</code> and have ffmpeg installed:
{{cmd|apk add ffmpeg}}

After restarting the fpm service it should start generating thumbnails for videos.

== Clients ==
There are clients available for many platforms, Android included:
* https://nextcloud.org/sync-clients/{{dead link}} ''(nextcloud Sync clients)''
* https://nextcloud.com/install/ ''(Android client)''

{{pkg|nextcloud-client}} is currently available in the community repo.

= Video Communication =
One of the major features of Nextcloud 11, available on Alpine 3.6 (currently edge) is a [https://nextcloud.com/webrtc/ WebRTC app], which relies on Spreed WebRTC server, which is available in the Alpine testing repository. Everything is still beta, so be aware of it :-). If you want a private video conferencing server install Nextcloud using Nginx and do the following (you can use Apache as well and follow the ''Apache config'' instructions [https://nextcloud.com/webrtc/ nextcloud.com]):

Put the following config in the ''server'' section of Nginx:
<pre>
# Spreed WebRTC
location ^~ /webrtc {
proxy_pass http://127.0.0.1:8080;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_buffering on;
proxy_ignore_client_abort off;
proxy_redirect off;
proxy_connect_timeout 90;
proxy_send_timeout 90;
proxy_read_timeout 90;
proxy_buffer_size 4k;
proxy_buffers 4 32k;
proxy_busy_buffers_size 64k;
proxy_temp_file_write_size 64k;
proxy_next_upstream error timeout invalid_header http_502 http_503 http_504;
}
</pre>

Put the following section in the ''http'' section of Nginx:
<pre>
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
</pre>

Reload Nginx:
{{cmd|rc-service nginx reload}}

Install Spreed WedRTC server (make sure you have the testing [https://wiki.alpinelinux.org/wiki/Alpine_Linux_package_management#Packages_and_Repositories repository] enabled):
{{cmd|apk add spreed-web-server}}

Using the configuration file in ''/etc/spreed-webrtc/spreed-webrtc-server.conf'' follow the instructions at [https://nextcloud.com/webrtc/ nextcloud.com] to configure Spreed WebRTC server. Then start the server:
{{cmd|rc-service spreed-web-server start}}
{{cmd|rc-update add spreed-web-server}}

Install the ''Spreed video calls'' app in Nextcloud and enjoy your private video calls.

= Nextcloud CLI occ =

Install it first
{{cmd|apk add nextcloud-occ}}

Access to nextcloud's CLI tool occ. Please be aware of which "php8x" version your installed version of Nextcloud is using and update the below commands accordingly. In the below examples, the system is using php82.

If using doas:
{{cmd|doas -u nextcloud php82 /usr/share/webapps/nextcloud/occ}}

If using sudo:
{{cmd|sudo -u nextcloud php82 /usr/share/webapps/nextcloud/occ}}

= Upgrading =

If you're using alpine stable, rather than edge, be aware when an upgrade skips a major release version: Nextcloud doesn't support skipping a major release version in its upgrade path. For this reason, alpine also packages the previous nextcloud release as a separate package.

== See also ==
* [https://wiki.archlinux.org/title/Nextcloud Nextcloud - Archwiki]

[[Category:Server]]

Talk:How-To Alpine Wall

2025-05-20T13:15:02Z

Jahway603: Added helpful resource

This article is confusing, but I discovered https://www.cyberciti.biz/faq/how-to-set-up-a-firewall-with-awall-on-alpine-linux/ which was very helpful to configure awall. Should this be included in "See also" section of this wiki page? [[User:Jahway603|Jahway603]] ([[User talk:Jahway603|talk]])

Nextcloud

2025-05-19T17:10:16Z

Jahway603: /* Nextcloud CLI occ */ added doas example and clarified to check which php version the user is using

[https://nextcloud.com/ Nextcloud] is WedDAV-based solution for storing and sharing on-line your data, files, images, video, music, calendars and contacts. [https://karlitschek.de/2016/06/nextcloud/ Nextcloud is a fork of ownCloud with enterprise features included].

= Installation =
{{pkg|nextcloud}} is available in Alpine 3.5 and greater.

Before you start installing anything, make sure you have the latest packages available. Make sure you are using an 'http' repository in your {{path|/etc/apk/repositories}} file, then:
{{cmd|apk update}}
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

== Database ==
First you have to decide which database to use. Use one of the databases listed below.

=== Sqlite ===
All you need to do is to install the package:
{{cmd|apk add nextcloud-sqlite}}

=== PostgreSQL ===
Install the package:
{{cmd|apk add nextcloud-pgsql postgresql postgresql-client}}

Next thing is to configure and start the database:
{{cmd|rc-service postgresql setup
rc-service postgresql start}}

Next, you need to create a user and temporarily grant the CREATEDB privilege:
{{cmd|psql -U postgres
CREATE USER mycloud WITH PASSWORD 'test123';
ALTER ROLE mycloud CREATEDB;
\q}}
{{Note|Replace the above username 'mycloud' and password 'test123' with something secure. Remember these settings. You will need them later when setting up nextcloud.}}

Set postgresql to start on boot/:
{{cmd|rc-update add postgresql}}

=== MariaDB ===
Install the package:
{{cmd|apk add nextcloud-mysql mariadb mariadb-client}}

Now configure and start {{pkg|mariadb}}:
{{cmd|<nowiki>mariadb-install-db --user=mysql --datadir=/var/lib/mysql</nowiki>
service mariadb start
rc-update add mariadb
mariadb-secure-installation}}
Follow the wizard to setup passwords, etc.
{{Note|Remember the usernames/passwords that you set using the wizard. You will need them later.}}

Next, you need to create a user and database and set permissions:
{{cmd|mariadb -u root -p
CREATE DATABASE nextcloud;
GRANT ALL ON nextcloud.* TO 'mycloud'@'localhost' IDENTIFIED BY 'test123';
GRANT ALL ON nextcloud.* TO 'mycloud'@'localhost.localdomain' IDENTIFIED BY 'test123';
FLUSH PRIVILEGES;
EXIT}}
{{Note|Replace the above username 'mycloud' and password 'test123' with something secure. Remember these settings. You will need them later when setting up nextcloud.}}

{{pkg|mariadb-client}} is not needed anymore. Let's uninstall it:
{{cmd|apk del mariadb-client}}

== Webserver ==
Next thing is to choose, install, and configure a webserver. In this example we will install {{pkg|nginx}} or {{pkg|lighttpd}}. You are free to install any other webserver of your choice as long as it supports PHP and FastCGI. Generating an SSL certificate for your webserver is outside of the scope of this document.

{{pkg|nextcloud-initscript}} facilitates running the webserver with php-fpm.

{{cmd|apk add nextcloud-initscript}}

=== Nginx ===
Install the needed packages:
{{cmd|apk add nginx}}

Delete the default nginx website configuration:
{{cmd|rm /etc/nginx/http.d/default.conf}}

Create a configuration file for your site in {{path|/etc/nginx/http.d/mysite.mydomain.com.conf}}:
{{Cat|/etc/nginx/http.d/mysite.mydomain.com.conf|server {
#listen [::]:80; #uncomment for IPv6 support
listen 80;
return 301 https://$host$request_uri;
server_name mysite.mydomain.com;
}

server {
#listen [::]:443 ssl; #uncomment for IPv6 support
listen 443 ssl;
server_name mysite.mydomain.com;

root /usr/share/webapps/nextcloud;
index index.php index.html index.htm;
disable_symlinks off;

ssl_certificate /etc/ssl/cert.pem;
ssl_certificate_key /etc/ssl/key.pem;
ssl_session_timeout 5m;

#Enable Perfect Forward Secrecy and ciphers without known vulnerabilities
#Beware! It breaks compatibility with older OS and browsers (e.g. Windows XP, Android 2.x, etc.)
#ssl_ciphers ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA;
#ssl_prefer_server_ciphers on;

location / {
try_files $uri $uri/ /index.html;
}

# pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}
#fastcgi_pass 127.0.0.1:9000;
#fastcgi_pass unix:/run/php-fpm/socket;
fastcgi_pass unix:/run/nextcloud/fastcgi.sock; # From the nextcloud-initscript package
fastcgi_index index.php;
include fastcgi.conf;
}

# Help pass nextcloud's configuration checks after install:
# Per https://docs.nextcloud.com/server/22/admin_manual/issues/general_troubleshooting.html#service-discovery
location ^~ /.well-known/carddav { return 301 /remote.php/dav/; }
location ^~ /.well-known/caldav { return 301 /remote.php/dav/; }
location ^~ /.well-known/webfinger { return 301 /index.php/.well-known/webfinger; }
location ^~ /.well-known/nodeinfo { return 301 /index.php/.well-known/nodeinfo; }

include mime.types;
types {
text/javascript mjs;
}

}
}}

If you plan to enable uploads - and you probably do) - then you need to modify the default:
<pre>
client_max_body_size 1m;'
</pre>
setting in {{path|/etc/nginx/nginx.conf}}. For testing purposes, I disabled the limit by changing it to:

<pre>
client_max_body_size 0;
</pre>

This enabled large file uploads and auto-uploads to work. Note, this is a file-size restriction in addition to the restriction set in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}. That second restriction defaults to:

<pre>
; Maximal size of a file that can be uploaded via web interface.
php_admin_value[memory_limit] = 512M
php_admin_value[post_max_size] = 513M
php_admin_value[upload_max_filesize] = 513M
</pre>

Another setting that may limit file-size is in configuration file {{path|/etc/php81/php.ini}}, where I set the restriction to to:
<pre>
upload_max_filesize = 513M
</pre>
to match the {{path|/etc/php81/php-fpm.d/nextcloud.conf}} file-size restriction.

If you are running from RAM and you're dealing with large files you might need to move the FastCGI temp file from {{path|/tmp}} to {{path|/var/tmp}} or to a directory that is mounted on hdd:
<pre>
fastcgi_temp_path /var/tmp/nginx/fastcgi 1 2;
</pre>

Large file uploads take some time to be processed by php-fpm, so you need to bump the Nginx default read timeout:

<pre>
fastcgi_read_timeout 300s;
</pre>

{{Note|If you are serving several users make sure to tune the *''pm.max_children'' setting in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}}}

{{path|/etc/nginx/nginx.conf}} should already be configured to load your site config from this directory:
<pre>
...
# Includes virtual hosts configs.
include /etc/nginx/http.d/*;
...
</pre>

Start services:
{{cmd|service nginx start
service nextcloud start}}

Enable automatic startup of services:
{{cmd|rc-update add nginx
rc-update add nextcloud}}

=== Lighttpd ===
Install the package:
{{cmd|apk add lighttpd php5-cgi}}

Make sure you have FastCGI enabled in {{pkg|lighttpd}}:
{{cat|/etc/lighttpd/lighttpd.conf|...
include "mod_fastcgi.conf"
...}}

Start up the webserver:
{{cmd|rc-service lighttpd start}}

{{tip|You might want to follow the [[Lighttpd_Advanced_security#Https_access|Lighttpd_Https_access]] doc in order to configure lighttpd to use https ''(securing your connections to your nextcloud server)''.}}

Link {{pkg|nextcloud}} installation to web server directory:
{{cmd|ln -s /usr/share/webapps/nextcloud /var/www/localhost/htdocs}}

== Firewall ==
Next up, open the desired port for the webserver in the firewall. You can use the following snippet as a reference for an nftable rule in a new file{{path|/etc/nftables.d/50-https.nft}}:
{{Cat|/etc/nftables.d/50-https.nft|
#!/usr/sbin/nft -f

table inet filter {
chain input {
# allow https
tcp dport 443 accept comment "accept HTTPS"
}
}
}}

== Other settings ==
=== Hardening ===
Consider updating the variable <code>url.access-deny</code> in {{path|/etc/lighttpd/lighttpd.conf}} for additional security. Add <code>"config.php"</code> to the variable ''(that's where the database is stored)'' so it looks something like this:
{{cat|/etc/lighttpd/lighttpd.conf|...
url.access-deny {{=}} ("~", ".inc", "config.php")
...}}
Restart {{pkg|lighttpd}} to activate the changes:
{{cmd|rc-service lighttpd restart}}

=== Additional packages ===
Some large apps, such as pdfviewer, texteditor, notifications and videoplayer are in separate packages:
{{cmd|apk add nextcloud-files_pdfviewer nextcloud-text nextcloud-notifications nextcloud-files_videoplayer nextcloud-files_external}}
You can also install the {{pkg|nextcloud-default-apps}} meta-package which installs all 30 core Nextcloud apps (listed as dependencies under aforementioned link):
{{cmd|apk add nextcloud-default-apps}}

=== How To Create a Self-Signed SSL Certificate ===
Install openssl:
{{cmd|apk add openssl}}
Generate your self signed certificate and its private key:
{{cmd|<nowiki>openssl req -x509 -nodes -days 365 -newkey rsa:4096 -keyout /etc/ssl1.1/private/nextcloud-selfsigned.key -out /etc/ssl1.1/certs/nextcloud-selfsigned.crt</nowiki>}}
Edit your nginx configuration:
{{cat|/etc/nginx/http.d/mysite.mydomain.com.conf|
ssl_certificate /etc/ssl1.1/certs/nextcloud-selfsigned.crt;
ssl_certificate_key /etc/ssl1.1/private/nextcloud-selfsigned.key;
}}

=== How To Install and Set Up Auto-Renewing LetsEncrypt SSL Certificate ===
After first setting up the Nextcloud server using the instructions in the 'Configure and use Nextcloud' section below, I then followed the SSL-setup instructions at: [[https://techjogging.com/create-letsencrypt-certificate-alpine-nginx.html Tech Jogging]].

I also had to add my Nextcloud servers Fully Qualified Domain Name (FQDN) to the list of trusted domains in /etc/nextcloud/config.php. In the section labelled: 'trusted_domains':

<pre>
'trusted_domains' =>
array (
0 => '<machine's local IP address>',
1 => 'nextcloud.mydomain.com',
),
}}
</pre>

= Configure and use Nextcloud =

== Configure ==
Point your browser at <code><nowiki>https://mysite.mydomain.com</nowiki></code> and follow the on-screen instructions to complete the installation, supplying the database user and password created before.

== Hardening PostgreSQL ==
If you have chosen PGSQL backend, revoke CREATEDB privilege from 'mycloud' user:
{{cmd|psql -U postgres
ALTER ROLE mycloud NOCREATEDB;
\q}}

== Increase upload size ==
{{path|/etc/php81/php-fpm.d/nextcloud.conf}} has overridden default file sizes, but they can be modified further to suit your needs:
<pre>
; Maximal size of a file that can be uploaded via web interface.
php_admin_value[memory_limit] = 512M
php_admin_value[post_max_size] = 513M
php_admin_value[upload_max_filesize] = 513M
</pre>

== Enable opcache for nginx/php81 ==
To increase performace install
{{cmd|apk add php81-opcache}}

Now uncomment/edit lines in /etc/php81/php.ini:
<pre>
...
opcache.enable=1
opcache.enable_cli=1
opcache.interned_strings_buffer=8
opcache.max_accelerated_files=10000
opcache.memory_consumption=128 //you can reduce this slightly when short on RAM
opcache.save_comments=1
opcache.revalidate_freq=1
...
</pre>

Restart php-fpm81
{{cmd|rc-service php-fpm81 restart}}

== Enable thumbnail for video ==

To be able to generate thumbnails for videos, besides [https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/previews_configuration.html configuring] nextcloud, you will need to unlist <code>proc_open</code> from php's disabled functions. PHP relies on that function to call ffmpeg to generate the thumbnails, without that it will fail to do so even if you have it enabled on config.php.

Remove <code>proc_open</code> from the disabled function in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}:

<pre>
; Disable certain functions for security reasons.
; http://php.net/disable-functions
php_admin_value[disable_functions] = exec,passthru,shell_exec,system,curl_multi_exec,show_source
</pre>

Now add <code>'OC\\Preview\\Movie'</code> to the list of <code>'enabledPreviewProviders'</code> and have ffmpeg installed:
{{cmd|apk add ffmpeg}}

After restarting the fpm service it should start generating thumbnails for videos.

== Clients ==
There are clients available for many platforms, Android included:
* https://nextcloud.org/sync-clients/{{dead link}} ''(nextcloud Sync clients)''
* https://nextcloud.com/install/ ''(Android client)''

{{pkg|nextcloud-client}} is currently available in the community repo.

= Video Communication =
One of the major features of Nextcloud 11, available on Alpine 3.6 (currently edge) is a [https://nextcloud.com/webrtc/ WebRTC app], which relies on Spreed WebRTC server, which is available in the Alpine testing repository. Everything is still beta, so be aware of it :-). If you want a private video conferencing server install Nextcloud using Nginx and do the following (you can use Apache as well and follow the ''Apache config'' instructions [https://nextcloud.com/webrtc/ nextcloud.com]):

Put the following config in the ''server'' section of Nginx:
<pre>
# Spreed WebRTC
location ^~ /webrtc {
proxy_pass http://127.0.0.1:8080;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_buffering on;
proxy_ignore_client_abort off;
proxy_redirect off;
proxy_connect_timeout 90;
proxy_send_timeout 90;
proxy_read_timeout 90;
proxy_buffer_size 4k;
proxy_buffers 4 32k;
proxy_busy_buffers_size 64k;
proxy_temp_file_write_size 64k;
proxy_next_upstream error timeout invalid_header http_502 http_503 http_504;
}
</pre>

Put the following section in the ''http'' section of Nginx:
<pre>
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
</pre>

Reload Nginx:
{{cmd|rc-service nginx reload}}

Install Spreed WedRTC server (make sure you have the testing [https://wiki.alpinelinux.org/wiki/Alpine_Linux_package_management#Packages_and_Repositories repository] enabled):
{{cmd|apk add spreed-web-server}}

Using the configuration file in ''/etc/spreed-webrtc/spreed-webrtc-server.conf'' follow the instructions at [https://nextcloud.com/webrtc/ nextcloud.com] to configure Spreed WebRTC server. Then start the server:
{{cmd|rc-service spreed-web-server start}}
{{cmd|rc-update add spreed-web-server}}

Install the ''Spreed video calls'' app in Nextcloud and enjoy your private video calls.

= Nextcloud CLI occ =

Access to nextcloud's CLI tool occ (be mindful of which `php8x` version you are using and update your command accordingly - in the example it is php82):

If using `doas`:
{{cmd|doas -u nextcloud php82 /usr/share/webapps/nextcloud/occ}}

If using `sudo`:
{{cmd|sudo -u nextcloud php82 /usr/share/webapps/nextcloud/occ}}

= Upgrading =

If you're using alpine stable, rather than edge, be aware when an upgrade skips a major release version: Nextcloud doesn't support skipping a major release version in its upgrade path. For this reason, alpine also packages the previous nextcloud release as a separate package.

== See also ==
* [https://wiki.archlinux.org/title/Nextcloud Nextcloud - Archwiki]

[[Category:Server]]

Talk:Nextcloud

2025-05-19T17:07:49Z

Jahway603:

There are a few missing steps that turn into warnings in the UI

* enabling APCu or another cache
(set in a apcu.ini AND config.php)

Is there a reason why php5-fpm is recommended instead of php7-fpm?
Php5 isn't supported by many applications anymore and will soon become deprecated.

== Descriptions for additional nextcloud packages is missing ==

There is no list or descriptions for additional nextcloud packages on this wiki article. I just upgraded my Alpine install and would like determine which additional packages I should install.

— Preceding [[Help:Signature|unsigned]] comment added by [[User:Jahway603|Jahway603]] ([[User talk:Jahway603|{{int:talkpagelinktext}}]] • [[Special:Contributions/Jahway603|{{int:contribslink}}]]) 12:31, 19 April 2023‎

== Default Data Directory Info is missing ==

Unsure where in this wiki the Nextcloud default data directory of `/var/lib/nextcloud/data` should be entered.

— Preceding [[Help:Signature|unsigned]] comment added by [[User:Jahway603|Jahway603]] ([[User talk:Jahway603|{{int:talkpagelinktext}}]] • [[Special:Contributions/Jahway603|{{int:contribslink}}]]) 09:29, 15 December 2023‎

== Nginx Config update ==

I'd like to propose changing the nginx config to an adaption of the config suggested by the nextcloud documentation: https://docs.nextcloud.com/server/latest/admin_manual/installation/nginx.html

My minimal adaption is here: https://gist.github.com/rgeber/1b40a05310cabab551c9ef87b504af8e

== What is the "Best method" to indicate in the wiki that there are different php version for different Nextcloud versions??? ==

ZNC

2025-03-20T13:39:06Z

Jahway603: Fixed package name typo

[https://wiki.znc.in/ZNC ZNC] is an advanced IRC bouncer that can establish such a permanent connection to several IRC networks and channels so your IRC client (or multiple clients) can disconnect/reconnect without losing the chat session, while appearing as a single user to other users.

== Installation ==
Install the package that contains ZNC.
{{Cmd|apk add znc}}
Create a ZNC configuration file, this command will automatically create znc.conf in {{path|/var/lib/znc/configs/}}. You will be asked to enter some information.
{{Cmd|rc-service znc setup}}
{{Note|Make sure the information you enter is as it's shown below.}}
Listen on port: 1025
Listen using SSL: yes
Listen using both IPv4 and IPv6: no
Username: your_username
Enter password: your_password
Confirm password: your_password
Nick: nick
Alternate nick: nick_
Real name: optional
Bind host: try to leave empty
Set up a network? no
Launch ZNC now? no
{{Warning|Never edit the configuration file while ZNC is running; always check with <code>htop</code> or <code>rc-status</code> if ZNC is running.}}
Start ZNC as service.
{{Cmd|rc-service znc start}}

== Run ZNC in a subdomain using NGINX ==

=== Configure the ZNC webadmin page ===

Open the ZNC webadmin page <code><nowiki>https://YOUR_SERVER_IP:1025</nowiki></code> in your browser. Accept the insecure certificate and go forward.
Log in with your username and password and go to global settings.
We want to maintain the webadmin connections separate from the IRC connections.
Let's make a listening port for the IRC connections.

In Listen Port(s) add:

Port: 6697
BindHost: *
SSL: on
IPv4: on
IPv6: off
IRC: on
HTTP: off
URIPrefix: /
Save the information you entered and stop the service for now.
{{Cmd|rc-service znc stop}}
Edit the configuration file.
{{Cmd|vim /var/lib/znc/configs/znc.conf}}

{{Note|Listener0 is the webadmin port (it's listening port 1025). Listener1 is the IRC port (it's listening port 6697).}}
Your configuration file should look like this:

{{Cat|/lib/znc/configs/znc.conf|<nowiki>
<Listener listener0>
Allow IRC = false
AllowWeb = true
IPv4 = true
IPv6 = false
Port = 1025
SSL = false
URIPrefix = /

<Listener listener1>
AllowIRC = true
AllowWeb = false
IPv4 = true
IPv6 = false
Port = 6697
SSL = true
URIPrefix = /
</nowiki>
}}

Start ZNC as service.
{{Cmd|rc-service znc start}}

=== Configure NGINX ===
Install NGINX if you haven't already.
{{Cmd|apk add nginx}}
Create a configuration file in conf.d separated from the main configuration files.
{{Cmd|vim /etc/nginx/conf.d/znc.your_domain.com.conf}}
The file should look something like below.
{{Cat|/etc/nginx/conf.d/znc.your_domain.com.conf|<nowiki>
server {
server_name znc.yourdomain.com;
location / {
proxy_pass http://localhost:1025;
}
}
</nowiki>
}}
Restart the NGINX service.
{{Cmd|rc-service nginx restart}}

=== Set up SSL certificates ===
{{Note|We opt to use SSL certificates made by Let's Encrypt, instead of using the znc.pem certificate that comes with the program.}}
Install Certbot and its module to work with NGINX.
{{Cmd|apk add certbot certbot-nginx}}
Run Certbot, this program will create Let's Encrypt SSL certificates for free. You will have to manually or automatically renew them every month.
{{Cmd|certbot}}
Restart NGINX and you're done. Your webadmin page will be automatically running the SSL certificate made by Let's Encrypt.
{{Cmd|rc-service nginx restart}}
Now we will replace the znc.pem certificate with the Let's Encrypt certificates for any person who wants to connect to our IRC bouncer. For this we need to concatenate two important files into znc.pem
{{Cmd|cat /etc/letsencrypt/live/your_domain.com/privkey.pem /etc/letsencrypt/live/your_domain.com/fullchain.pem > /var/lib/znc/znc.pem}}
[[Category:Server]]

Ddclient

2024-10-23T16:17:44Z

Jahway603: Added a "See Also" section with relevant links

{{TOC right}}

== How to download and install the latest version of ddclient ==

[https://github.com/ddclient/ddclient DDclient] is a perl script to update accounts for Dynamic DNS Service Provider.

== Install ==

ddclient is available in community repository as of Alpine Linux 3.19.

In order to use it, you need to first install it:

<code># apk update</code>

<code># apk add ddclient</code>

== Configuration ==

A sample configuration file is installed by default as <code>/etc/ddclient/ddclient.conf</code>, so you can modify it according to your needs.

Then, start ddclient as usual:

<code># rc-service ddclient start</code>

If you want/need, configure the service to start automatically on boot:

<code># rc-update add ddclient default</code>

== See Also ==
* [https://ddclient.net/ Ddclient Homepage]
* [https://github.com/ddclient/ddclient Ddclient Github repo]

[[Category:Networking]]

Ddclient

2024-10-23T16:00:13Z

Jahway603: changed sample conf to what is included within the package

Ddclient

2024-10-23T15:57:31Z

Jahway603: update that ddclient has been avail in community repo since Alpine 3.19

{{TOC right}}

== How to download and install the latest version of ddclient ==

[https://github.com/ddclient/ddclient DDclient] is a perl script to update accounts for Dynamic DNS Service Provider.

== Install ==

ddclient is available in community repository as of Alpine Linux 3.19.

In order to use it, you need to first install it:

<code># apk update</code>

<code># apk add ddclient</code>

== Configuration ==

A sample configuration file is installed by default in <code>/etc/ddclient/ddclient.conf.sample.</code>

Rename it as <code>/etc/ddclient/ddclient.conf</code> and modify it according to your needs.

Then, start ddclient as usual:

<code># rc-service ddclient start</code>

If you want/need, configure the service to start automatically on boot:

<code># rc-update add ddclient default</code>

[[Category:Networking]]

HAProxy

2024-09-18T15:50:18Z

Jahway603: Added HAProxy Installation section

[https://www.haproxy.org/ HAProxy] is a free, very fast, and reliable reverse-proxy offering high availability, load balancing, and proxying for TCP and HTTP-based applications.

A unique feature is that HAProxy can be configured for SSL termination to occur locally on the HAProxy server or it can be configured to pass through SSL termination at the backend via SNI.

== Installation ==
HAProxy package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add haproxy}}

=== System scripts ===
If you are running OpenRC, then you can install with:

{{Cmd|apk update
apk add haproxy-openrc}}

If you are running runit, s6, or dinit, (or other), then there are no scripts packaged for your init systems yet. Please feel free to contribute a package with them.

=== Local Documentation ===
If you want local documenation, then you can install that with:

{{Cmd|apk add haproxy-doc}}

== See Also ==

* [https://www.haproxy.org/ HAProxy Homepage]

[[Category:Web Server]]

Matrix

2024-09-18T15:48:02Z

Jahway603: minor grammar

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

=== Reverse Proxy ===

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].

The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[Nginx]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], or [[HAProxy]] to have in front of Synapse.

=== Database ===

Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used in a production environment.

The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

HAProxy

2024-09-18T15:33:21Z

Jahway603: Added Category:Web Server footer

Caddy

2024-09-18T15:32:16Z

Jahway603: Added Controlling Caddy section

[https://caddyserver.com/ Caddy] is a fast and extensible multi-platform HTTP/1, HTTP/2, and HTTP/3 web server with automatic TLS by default, providing HTTPS on every site.

== Intallation ==
Caddy package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add caddy}}

=== System scripts ===

If you are running OpenRC, then you can install those with:

{{Cmd|apk update
apk add caddy-openrc}}

If you are running runit, s6, or dinit, (or other), then there are no scripts packaged for your init systems yet. Please feel free to contribute a package with them.

== Configuration ==
Caddy's default config file when using the Artix package is /etc/caddy/Caddyfile.

Upstream provides [https://caddyserver.com/docs/caddyfile Caddyfile configuration documentation].

Here is a simple Caddyfile hosting the site at localhost:2020:
{{Cmd|{
http_port 2020
}

localhost:2020
file_server}}

== Controlling Caddy ==
=== Start Caddy ===
After the installation Caddy is not running. To start Caddy, use start.
{{Cmd|rc-service caddy start}}

Navigate a browser to the machine's address and a page should appear if you have configured /etc/caddy/Caddyfile correctly.

Enable Caddy on startup (if needed):

{{Cmd|# rc-update add caddy}}

Edit the configuration in {{Path|/etc/caddy/Caddyfile}} and run

{{Cmd|# rc-service caddy restart}}

to enable your changes

== See Also ==

* [https://caddyserver.com/ Caddy Homepage]

[[Category:Web Server]]

HAProxy

2024-09-18T02:47:41Z

Jahway603: Initial HAProxy wiki placeholder

Matrix

2024-09-18T02:43:51Z

Jahway603: removed relayd as reverse proxy as package does not exist on Alpine

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

=== Reverse Proxy ===

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].

The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[nginx]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], or [[HAProxy]] to have in front of Synapse.

=== Database ===

Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used in a production environment.

The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

Caddy

2024-09-18T02:41:48Z

Jahway603: Began the Caddy wiki article

Matrix

2024-09-18T02:28:54Z

Jahway603: Provided more reverse proxy info from upstream

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

=== Reverse Proxy ===

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].

The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[nginx]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], [[HAProxy]] or [[relayd]] to have in front of Synapse.

=== Database ===

Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used in a production environment.

The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

Matrix

2024-09-18T02:19:41Z

Jahway603: Added upstream link to reverse proxy configuration examples

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples the Matrix Synapse documentation has examples] for each one. I prefer [[nginx]], as I am familiar with it. Please make the best reverse proxy choice of one that you are familiar with, or that you want to learn more about.

=== Database ===

Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.

The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

Matrix

2024-07-23T02:48:17Z

Jahway603: fixed incorrectly formatted weblink

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as the Matrix Synapse documentation has examples for each one. I recommend nginx, which you can read more about on the [https://wiki.alpinelinux.org/wiki/Nginx Nginx Alpine Wiki page].

=== Database ===

Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.

The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [https://wiki.alpinelinux.org/wiki/Postgresql PostgreSQL Alpine wiki page]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

Postgresql

2024-07-23T02:38:49Z

Jahway603: added guide for Upgrading PostgreSQL

= General =

PostgreSQL is a well known opensource database that scales well and is easy to use.

== PostgreSQL 16 ==

To install, configure, and use PostgreSQL 16, which is the latest release, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page]. It will also create a system user called postgres.

== PostgreSQL 15 ==

To install PostgreSQL 15,
{{Cmd|apk add postgresql15 postgresql15-contrib postgresql15-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql 15 server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== PostgreSQL 14 ==

To install PostgreSQL 14,
{{Cmd|apk add postgresql14 postgresql14-contrib postgresql14-openrc}}
{{Cmd|rc-update add postgresql}}
{{Cmd|rc-service postgresql start}}

This will start the postgresql 14 server and perform some initial configuration. It will also create a system user called postgres.

To configure and use PostgreSQL, please refer to the [https://wiki.alpinelinux.org/wiki/Postgresql_16 PostgreSQL 16 Alpine Wiki page] as the usage is the same.

== Switching between PostgreSQL versions ==

On Alpine Linux, you can use the command `pg_versions` to switch between PostgreSQL versions. This is very helpful when upgrading the version you are using.

== Upgrading PostgreSQL ==

Please follow along with [https://beune.dev/posts/upgrade-alpine-postgresql/ this guide] and substitute the version you are moving from and the version you are upgrading to.

Postgresql

2024-07-23T01:20:36Z

Jahway603: added section: Switching between PostgreSQL versions

Matrix

2024-07-22T02:16:08Z

Jahway603: minor edit to fix page link

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as the Matrix Synapse documentation has examples for each one. I recommend nginx, which you can read more about on the [https://wiki.alpinelinux.org/wiki/Nginx Nginx Alpine Wiki page].

=== Database ===

Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.

The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [PostgreSQL Alpine wiki page https://wiki.alpinelinux.org/wiki/Postgresql]. It is recommended that you install the latest release available of PostgreSQL, which at this time is PostgreSQL 16.

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

Talk:Postgresql 16

2024-07-22T01:54:09Z

Jahway603: Blanked the page

Matrix

2024-07-22T01:52:35Z

Jahway603: add databse backend section

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as the Matrix Synapse documentation has examples for each one. I recommend nginx, which you can read more about on the [https://wiki.alpinelinux.org/wiki/Nginx Nginx Alpine Wiki page].

=== Database ===

Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.

The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [PostgreSQL Alpine wiki pagehttps://wiki.alpinelinux.org/wiki/Postgresql]. It is recommended that you install the latest release available of PostgreSQL, which at this time is PostgreSQL 16.

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

Postgresql

2024-07-22T01:51:11Z

Jahway603: initial PostgreSQL wiki page

Matrix

2024-07-22T01:14:42Z

Jahway603: add info about synapse config and reverse proxy examples

[https://matrix.org/ Matrix] is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, [https://matrix.org/clients/ various clients] and [https://matrix.org/bridges/ bridge] software to connect to existing messaging solutions such as IRC (Internet Relay Chat).

The [[Alpine Linux:IRC|Alpine Linux IRC chatrooms]] are bridged to Matrix. The General Alpine Linux room can be found on Matrix here [https://matrix.to/#/#_oftc_#alpine-linux:matrix.org #_oftc_#alpine-linux:matrix.org]. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.

= Installation =
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.

The reference server implementation Synapse, which is the most commonly used server, is available as the {{pkg|synapse}} package. It has been available since Alpine 3.11.

There is also a second-generation Matrix homeserver written in Go, which is available as the {{pkg|dendrite}} package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.

There is also another Matrix homeserver, written in Rust, which is available as the {{pkg|conduit}} package and is only currently available in the Alpine Edge at this time.

Before you start installing anything, make sure you have the latest packages available.
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

= Matrix Synapse server =

This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time.

== Install Matrix Synapse server ==

Synapse package is available in the Alpine Linux repositories. To install it run:

{{Cmd|apk update
apk add synapse}}

When installing the Alpine Linux synapse package, it will create a user called ''synapse''.

== Configuration and Setup ==

During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}.

You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as the Matrix Synapse documentation has examples for each one. I recommend nginx, which you can read more about on the [https://wiki.alpinelinux.org/wiki/Nginx Nginx Alpine Wiki page].

== Database ==

== See also ==
* [https://wiki.archlinux.org/title/Matrix Matrix - Archwiki]
* [https://element-hq.github.io/synapse/ Matrix Synapse Documentation]
* [https://github.com/element-hq/synapse Matrix Synapse Github]
* [https://github.com/matrix-org/dendrite Matrix Dendrite Github]
* [https://conduit.rs/ Matrix Conduit Website]

[[Category:Server]]

User talk:Jahway603

2024-07-19T15:04:45Z

Jahway603: first talk page

Unsure of what to place here other that I've been really enjoying using and contributing to Alpine Linux

Matrix

2024-07-19T15:03:30Z

Jahway603: Added synapse install documentation

Talk:Postgresql 16

2024-07-01T01:26:15Z

Jahway603: question about postgresql versions

Should this page be replicated for other Postgresql versions or should this page contain instructions, or at least mention, regarding installing different versions available? 01:26, 1 July 2024 (UTC)

Matrix

2024-06-30T15:23:46Z

Jahway603: minor grammar change

Matrix

2024-06-30T15:22:25Z

Jahway603: fixed IRC link

Matrix

2024-06-30T15:14:19Z

Jahway603: heading change

Matrix

2024-06-30T15:13:57Z

Jahway603: created

Nextcloud

2024-05-29T18:59:53Z

Jahway603: Installing nextcloud-initscript APK will install the correct php8x-fpm APK

[https://nextcloud.com/ Nextcloud] is WedDAV-based solution for storing and sharing on-line your data, files, images, video, music, calendars and contacts. [https://karlitschek.de/2016/06/nextcloud/ Nextcloud is a fork of ownCloud with enterprise features included].

= Installation =
{{pkg|nextcloud}} is available from Alpine 3.5 and greater.

Before you start installing anything, make sure you have the latest packages available. Make sure you are using an 'http' repository in your {{path|/etc/apk/repositories}} file, then:
{{cmd|apk update}}
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}}

== Database ==
First you have to decide which database to use. Use one of the databases listed below.

=== Sqlite ===
All you need to do is to install the package:
{{cmd|apk add nextcloud-sqlite}}

=== PostgreSQL ===
Install the package:
{{cmd|apk add nextcloud-pgsql postgresql postgresql-client}}

Next thing is to configure and start the database:
{{cmd|rc-service postgresql setup
rc-service postgresql start}}

Next, you need to create a user and temporarily grant the CREATEDB privilege:
{{cmd|psql -U postgres
CREATE USER mycloud WITH PASSWORD 'test123';
ALTER ROLE mycloud CREATEDB;
\q}}
{{Note|Replace the above username 'mycloud' and password 'test123' with something secure. Remember these settings. You will need them later when setting up nextcloud.}}

Set postgresql to start on boot/:
{{cmd|rc-update add postgresql}}

=== MariaDB ===
Install the package:
{{cmd|apk add nextcloud-mysql mariadb mariadb-client}}

Now configure and start {{pkg|mariadb}}:
{{cmd|<nowiki>mysql_install_db --user=mysql --datadir=/var/lib/mysql</nowiki>
service mariadb start
rc-update add mariadb
mysql_secure_installation}}
Follow the wizard to setup passwords, etc.
{{Note|Remember the usernames/passwords that you set using the wizard. You will need them later.}}

Next, you need to create a user and database and set permissions:
{{cmd|mysql -u root -p
CREATE DATABASE nextcloud;
GRANT ALL ON nextcloud.* TO 'mycloud'@'localhost' IDENTIFIED BY 'test123';
GRANT ALL ON nextcloud.* TO 'mycloud'@'localhost.localdomain' IDENTIFIED BY 'test123';
FLUSH PRIVILEGES;
EXIT}}
{{Note|Replace the above username 'mycloud' and password 'test123' with something secure. Remember these settings. You will need them later when setting up nextcloud.}}

{{pkg|mariadb-client}} is not needed anymore. Let's uninstall it:
{{cmd|apk del mariadb-client}}

== Webserver ==
Next thing is to choose, install, and configure a webserver. In this example we will install {{pkg|nginx}} or {{pkg|lighttpd}}. You are free to install any other webserver of your choice as long as it supports PHP and FastCGI. Generating an SSL certificate for your webserver is outside of the scope of this document.

{{pkg|nextcloud-initscript}} facilitates running the webserver with php-fpm.

{{cmd|apk add nextcloud-initscript}}

=== Nginx ===
Install the needed packages:
{{cmd|apk add nginx}}

Delete the default nginx website configuration:
{{cmd|rm /etc/nginx/http.d/default.conf}}

Create a configuration file for your site in {{path|/etc/nginx/http.d/mysite.mydomain.com.conf}}:
{{Cat|/etc/nginx/http.d/mysite.mydomain.com.conf|server {
#listen [::]:80; #uncomment for IPv6 support
listen 80;
return 301 https://$host$request_uri;
server_name mysite.mydomain.com;
}

server {
#listen [::]:443 ssl; #uncomment for IPv6 support
listen 443 ssl;
server_name mysite.mydomain.com;

root /usr/share/webapps/nextcloud;
index index.php index.html index.htm;
disable_symlinks off;

ssl_certificate /etc/ssl/cert.pem;
ssl_certificate_key /etc/ssl/key.pem;
ssl_session_timeout 5m;

#Enable Perfect Forward Secrecy and ciphers without known vulnerabilities
#Beware! It breaks compatibility with older OS and browsers (e.g. Windows XP, Android 2.x, etc.)
#ssl_ciphers ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA;
#ssl_prefer_server_ciphers on;

location / {
try_files $uri $uri/ /index.html;
}

# pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}
#fastcgi_pass 127.0.0.1:9000;
#fastcgi_pass unix:/run/php-fpm/socket;
fastcgi_pass unix:/run/nextcloud/fastcgi.sock; # From the nextcloud-initscript package
fastcgi_index index.php;
include fastcgi.conf;
}

# Help pass nextcloud's configuration checks after install:
# Per https://docs.nextcloud.com/server/22/admin_manual/issues/general_troubleshooting.html#service-discovery
location ^~ /.well-known/carddav { return 301 /remote.php/dav/; }
location ^~ /.well-known/caldav { return 301 /remote.php/dav/; }
location ^~ /.well-known/webfinger { return 301 /index.php/.well-known/webfinger; }
location ^~ /.well-known/nodeinfo { return 301 /index.php/.well-known/nodeinfo; }
}
}}

If you plan to enable uploads - and you probably do) - then you need to modify the default:
<pre>
client_max_body_size 1m;'
</pre>
setting in {{path|/etc/nginx/nginx.conf}}. For testing purposes, I disabled the limit by changing it to:

<pre>
client_max_body_size 0;
</pre>

This enabled large file uploads and auto-uploads to work. Note, this is a file-size restriction in addition to the restriction set in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}. That second restriction defaults to:

<pre>
; Maximal size of a file that can be uploaded via web interface.
php_admin_value[memory_limit] = 512M
php_admin_value[post_max_size] = 513M
php_admin_value[upload_max_filesize] = 513M
</pre>

Another setting that may limit file-size is in configuration file {{path|/etc/php81/php.ini}}, where I set the restriction to to:
<pre>
upload_max_filesize = 513M
</pre>
to match the {{path|/etc/php81/php-fpm.d/nextcloud.conf}} file-size restriction.

If you are running from RAM and you're dealing with large files you might need to move the FastCGI temp file from {{path|/tmp}} to {{path|/var/tmp}} or to a directory that is mounted on hdd:
<pre>
fastcgi_temp_path /var/tmp/nginx/fastcgi 1 2;
</pre>

Large file uploads take some time to be processed by php-fpm, so you need to bump the Nginx default read timeout:

<pre>
fastcgi_read_timeout 300s;
</pre>

{{Note|If you are serving several users make sure to tune the *''pm.max_children'' setting in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}}}

{{path|/etc/nginx/nginx.conf}} should already be configured to load your site config from this directory:
<pre>
...
# Includes virtual hosts configs.
include /etc/nginx/http.d/*;
...
</pre>

Start services:
{{cmd|service nginx start
service nextcloud start}}

Enable automatic startup of services:
{{cmd|rc-update add nginx
rc-update add nextcloud}}

=== Lighttpd ===
Install the package:
{{cmd|apk add lighttpd php5-cgi}}

Make sure you have FastCGI enabled in {{pkg|lighttpd}}:
{{cat|/etc/lighttpd/lighttpd.conf|...
include "mod_fastcgi.conf"
...}}

Start up the webserver:
{{cmd|rc-service lighttpd start}}

{{tip|You might want to follow the [[Lighttpd_Advanced_security#Https_access|Lighttpd_Https_access]] doc in order to configure lighttpd to use https ''(securing your connections to your nextcloud server)''.}}

Link {{pkg|nextcloud}} installation to web server directory:
{{cmd|ln -s /usr/share/webapps/nextcloud /var/www/localhost/htdocs}}

== Firewall ==
Next up, open the desired port for the webserver in the firewall. You can use the following snippet as a reference for an nftable rule in a new file{{path|/etc/nftables.d/50-https.nft}}:
{{Cat|/etc/nftables.d/50-https.nft|
#!/usr/sbin/nft -f

table inet filter {
chain input {
# allow https
tcp dport 443 accept comment "accept HTTPS"
}
}
}}

== Other settings ==
=== Hardening ===
Consider updating the variable <code>url.access-deny</code> in {{path|/etc/lighttpd/lighttpd.conf}} for additional security. Add <code>"config.php"</code> to the variable ''(that's where the database is stored)'' so it looks something like this:
{{cat|/etc/lighttpd/lighttpd.conf|...
url.access-deny {{=}} ("~", ".inc", "config.php")
...}}
Restart {{pkg|lighttpd}} to activate the changes:
{{cmd|rc-service lighttpd restart}}

=== Additional packages ===
Some large apps, such as pdfviewer, texteditor, notifications and videoplayer are in separate packages:
{{cmd|apk add nextcloud-files_pdfviewer nextcloud-text nextcloud-notifications nextcloud-files_videoplayer nextcloud-files_external}}
You can also install the {{pkg|nextcloud-default-apps}} meta-package which installs all 30 core Nextcloud apps (listed as dependencies under aforementioned link):
{{cmd|apk add nextcloud-default-apps}}

=== How To Create a Self-Signed SSL Certificate ===
Install openssl:
{{cmd|apk add openssl}}
Generate your self signed certificate and its private key:
{{cmd|<nowiki>openssl req -x509 -nodes -days 365 -newkey rsa:4096 -keyout /etc/ssl1.1/private/nextcloud-selfsigned.key -out /etc/ssl1.1/certs/nextcloud-selfsigned.crt</nowiki>}}
Edit your nginx configuration:
{{cat|/etc/nginx/http.d/mysite.mydomain.com.conf|
ssl_certificate /etc/ssl1.1/certs/nextcloud-selfsigned.crt;
ssl_certificate_key /etc/ssl1.1/private/nextcloud-selfsigned.key;
}}

=== How To Install and Set Up Auto-Renewing LetsEncrypt SSL Certificate ===
After first setting up the Nextcloud server using the instructions in the 'Configure and use Nextcloud' section below, I then followed the SSL-setup instructions at: [[https://techjogging.com/create-letsencrypt-certificate-alpine-nginx.html Tech Jogging]].

I also had to add my Nextcloud servers Fully Qualified Domain Name (FQDN) to the list of trusted domains in /etc/nextcloud/config.php. In the section labelled: 'trusted_domains':

<pre>
'trusted_domains' =>
array (
0 => '<machine's local IP address>',
1 => 'nextcloud.mydomain.com',
),
}}
</pre>

= Configure and use Nextcloud =

== Configure ==
Point your browser at <code><nowiki>https://mysite.mydomain.com</nowiki></code> and follow the on-screen instructions to complete the installation, supplying the database user and password created before.

== Hardening PostgreSQL ==
If you have chosen PGSQL backend, revoke CREATEDB privilege from 'mycloud' user:
{{cmd|psql -U postgres
ALTER ROLE mycloud NOCREATEDB;
\q}}

== Increase upload size ==
{{path|/etc/php81/php-fpm.d/nextcloud.conf}} has overridden default file sizes, but they can be modified further to suit your needs:
<pre>
; Maximal size of a file that can be uploaded via web interface.
php_admin_value[memory_limit] = 512M
php_admin_value[post_max_size] = 513M
php_admin_value[upload_max_filesize] = 513M
</pre>

== Enable opcache for nginx/php81 ==
To increase performace install
{{cmd|apk add php81-opcache}}

Now uncomment/edit lines in /etc/php81/php.ini:
<pre>
...
opcache.enable=1
opcache.enable_cli=1
opcache.interned_strings_buffer=8
opcache.max_accelerated_files=10000
opcache.memory_consumption=128 //you can reduce this slightly when short on RAM
opcache.save_comments=1
opcache.revalidate_freq=1
...
</pre>

Restart php-fpm81
{{cmd|rc-service php-fpm81 restart}}

== Enable thumbnail for video ==

To be able to generate thumbnails for videos, besides [https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/previews_configuration.html configuring] nextcloud, you will need to unlist <code>proc_open</code> from php's disabled functions. PHP relies on that function to call ffmpeg to generate the thumbnails, without that it will fail to do so even if you have it enabled on config.php.

Remove <code>proc_open</code> from the disabled function in {{path|/etc/php81/php-fpm.d/nextcloud.conf}}:

<pre>
; Disable certain functions for security reasons.
; http://php.net/disable-functions
php_admin_value[disable_functions] = exec,passthru,shell_exec,system,curl_multi_exec,show_source
</pre>

Now add <code>'OC\\Preview\\Movie'</code> to the list of <code>'enabledPreviewProviders'</code> and have ffmpeg installed:
{{cmd|apk add ffmpeg}}

After restarting the fpm service it should start generating thumbnails for videos.

== Clients ==
There are clients available for many platforms, Android included:
* https://nextcloud.org/sync-clients/{{dead link}} ''(nextcloud Sync clients)''
* https://nextcloud.com/install/ ''(Android client)''

{{pkg|nextcloud-client}} is currently available in the community repo.

= Video Communication =
One of the major features of Nextcloud 11, available on Alpine 3.6 (currently edge) is a [https://nextcloud.com/webrtc/ WebRTC app], which relies on Spreed WebRTC server, which is available in the Alpine testing repository. Everything is still beta, so be aware of it :-). If you want a private video conferencing server install Nextcloud using Nginx and do the following (you can use Apache as well and follow the ''Apache config'' instructions [https://nextcloud.com/webrtc/ nextcloud.com]):

Put the following config in the ''server'' section of Nginx:
<pre>
# Spreed WebRTC
location ^~ /webrtc {
proxy_pass http://127.0.0.1:8080;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_buffering on;
proxy_ignore_client_abort off;
proxy_redirect off;
proxy_connect_timeout 90;
proxy_send_timeout 90;
proxy_read_timeout 90;
proxy_buffer_size 4k;
proxy_buffers 4 32k;
proxy_busy_buffers_size 64k;
proxy_temp_file_write_size 64k;
proxy_next_upstream error timeout invalid_header http_502 http_503 http_504;
}
</pre>

Put the following section in the ''http'' section of Nginx:
<pre>
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
</pre>

Reload Nginx:
{{cmd|rc-service nginx reload}}

Install Spreed WedRTC server (make sure you have the testing [https://wiki.alpinelinux.org/wiki/Alpine_Linux_package_management#Packages_and_Repositories repository] enabled):
{{cmd|apk add spreed-web-server}}

Using the configuration file in ''/etc/spreed-webrtc/spreed-webrtc-server.conf'' follow the instructions at [https://nextcloud.com/webrtc/ nextcloud.com] to configure Spreed WebRTC server. Then start the server:
{{cmd|rc-service spreed-web-server start}}
{{cmd|rc-update add spreed-web-server}}

Install the ''Spreed video calls'' app in Nextcloud and enjoy your private video calls.

= Upgrading =

If you're using alpine stable, rather than edge, be aware when an upgrade skips a major release version: Nextcloud doesn't support skipping a major release version in its upgrade path. For this reason, alpine also packages the previous nextcloud release as a separate package.

== See also ==
* [https://wiki.archlinux.org/title/Nextcloud Nextcloud - Archwiki]

[[Category:Server]]

Talk:Nginx

2024-05-15T14:36:44Z

Jahway603: question about www user

Does this still require creating and using the user `www` when the default package installs a nginx user? [[User:Jahway603|Jahway603]] ([[User talk:Jahway603|talk]]) 14:36, 15 May 2024 (UTC)

Talk:Nextcloud

2023-12-15T14:29:26Z

Jahway603: Nextcloud Default Data Directory Info is missing

Talk:Nextcloud

2023-04-19T16:31:29Z

Jahway603: Descriptions for additional nextcloud packages is missing

User:Jahway603

2023-04-19T16:09:07Z

Jahway603: .

and then?

Talk:Rsnapshot

2023-04-19T16:08:34Z

Jahway603: broken automation script removed

Rsnapshot

2023-04-18T22:52:40Z

Jahway603: Fixed rsnapshot cron scripts

[http://rsnapshot.org/ <samp>rsnapshot</samp>] is a filesystem backup utility based on [[rsync|<samp>rsync</samp>]]. Using <samp>rsnapshot</samp>, it is possible to take snapshots of your filesystems at different points in time. Using hard links, rsnapshot creates the illusion of multiple full backups, while only taking up the space of one full backup plus differences. When coupled with <samp>ssh</samp>, it is possible to take snapshots of remote filesystems as well. This document is a tutorial on the installation and configuration of rsnapshot.

== Installation ==
To install rsnapshot:
<pre>
apk add rsnapshot
</pre>

== Configuration ==
To configure <samp>rsnapshot</samp>, copy the example configuration <samp>/etc/rsnapshot.conf.default</samp> to <samp>/etc/rsnapshot.conf</samp>, and edit it to your needs based on the comments and the [http://rsnapshot.org/rsnapshot/docs/docbook/rest.html official documentation]. Note that <samp>rsnapshot</samp> requires tabs between options and values in <samp>rsnapshot.conf</samp>. This is done so spaces can be included in filenames without requiring any extra escaping or quoting.

The most important parts to modify are where to store the backups:
<pre>
snapshot_root /mnt/backup
</pre>
How many backups to retain:

These settings used to be called "hourly, daily, weekly, monthly" in older releases of rsnapshot, but were changed to "alpha, beta, gamma, delta" because the time interval between backups is arbitrary.

Setting this means I end up with 6 backups which were done most recently, then one of those gets hived off to become the beta backup, which it keeps 7 of, one of which gets hived off as gamma, and so on. This means you have multiple alpha backups fairly recently, multiple older beta backups representing days then gamma representing weeks and delta backups going back months. Set this according to how many backups you want to have.
<pre>
retain alpha 6
retain beta 7
retain gamma 4
retain delta 3
</pre>
And what to backup:
<pre>
# Local
backup /home/ local/
backup /etc/ local/

# Remote
backup user@remote:/home/user/ remote/ exclude=/home/user/Downloads
</pre>
In this case, every 7th <samp>daily</samp> backup is saved as a <samp>weekly</samp> backup, every 4th <samp>weekly</samp> backup is retained as a <samp>monthly</samp> backup, and every 12th <samp>monthly</samp> backup is deleted. The folders <samp>/home</samp> and <samp>/etc</samp> from the local machine are backed up to <samp>/mnt/backup/local/</samp>, while it uses <samp>ssh</samp> to back up the folder <samp>/home/user</samp> on the machine <samp>remote</samp> to <samp>/mnt/backup/remote/</samp>. Make sure <samp>root</samp> has passwordless <samp>ssh</samp> access to the machines you want to backup over the internet (i.e. run <samp>ssh-keygen</samp> and <samp>ssh-copy-id</samp> as <samp>root</samp>). 
The last line also shows an example of how you can exclude parts of the location from backups.

== Testing ==
To test that your config file has the correct syntax:
<pre>
rsnapshot configtest
</pre>
To check what the system would do when running a backup without executing the commands, i.e. a dry run:
<pre>
rsnapshot -t alpha
rsnapshot -t beta
rsnapshot -t gamma
rsnapshot -t delta
</pre>
Finally, perform the first backup:
<pre>
rsnapshot alpha
</pre>
The last part might take a while. Subsequent backups should be much faster, as it will then only have to copy files that have changed since the last backup.

== Automation ==
After setting up and testing <samp>rsnapshot</samp> as described above, the next step is to make [[cron|<samp>cron</samp>]] automatically run <samp>rsnapshot</samp> at fixed intervals. The easiest way to achieve this is to create a few scripts in the folders <samp>/etc/periodic/*</samp> that <samp>crond</samp> monitors. The script below will write the appropriate contents to those files and make them executable:
<pre>
#!/bin/sh
cd /etc/periodic
dirs=("daily" "weekly" "monthly")

for dir in "${dirs[@]}"; do
echo -e "#!/bin/sh\nexec /usr/bin/rsnapshot $dir" > "$dir/rsnapshot"
chmod +x "$dir/rsnapshot"
done

</pre>

{{Cat|/etc/periodic/hourly/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot alpha
}}

{{Cat|/etc/periodic/daily/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot beta
}}

{{Cat|/etc/periodic/weekly/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot gamma
}}

{{Cat|/etc/periodic/monthly/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot delta
}}

Remember to make the scripts executable:
<pre>
chmod +x /etc/periodic/*/rsnapshot
</pre>
After that, test that the scripts work as expected:
<pre>
run-parts /etc/periodic/hourly
run-parts /etc/periodic/daily
run-parts /etc/periodic/weekly
run-parts /etc/periodic/monthly
</pre>
Assuming <samp>crond</samp> is set to start at boot (the default), your system should now make backups automatically.

[[Category:System Administration]]

Talk:Rsnapshot

2023-04-18T22:47:51Z

Jahway603: rsnapshot automation script broken

== Automation script is not working ==

Automation script is not working and having trouble fixing it [[User:Jahway603|Jahway603]] ([[User talk:Jahway603|talk]]) 22:47, 18 April 2023 (UTC)

Rsnapshot

2023-04-18T22:35:54Z

Jahway603: Fixed rsnapshot test commands while configuring on an Alpine system

[http://rsnapshot.org/ <samp>rsnapshot</samp>] is a filesystem backup utility based on [[rsync|<samp>rsync</samp>]]. Using <samp>rsnapshot</samp>, it is possible to take snapshots of your filesystems at different points in time. Using hard links, rsnapshot creates the illusion of multiple full backups, while only taking up the space of one full backup plus differences. When coupled with <samp>ssh</samp>, it is possible to take snapshots of remote filesystems as well. This document is a tutorial on the installation and configuration of rsnapshot.

== Installation ==
To install rsnapshot:
<pre>
apk add rsnapshot
</pre>

== Configuration ==
To configure <samp>rsnapshot</samp>, copy the example configuration <samp>/etc/rsnapshot.conf.default</samp> to <samp>/etc/rsnapshot.conf</samp>, and edit it to your needs based on the comments and the [http://rsnapshot.org/rsnapshot/docs/docbook/rest.html official documentation]. Note that <samp>rsnapshot</samp> requires tabs between options and values in <samp>rsnapshot.conf</samp>. This is done so spaces can be included in filenames without requiring any extra escaping or quoting.

The most important parts to modify are where to store the backups:
<pre>
snapshot_root /mnt/backup
</pre>
How many backups to retain:

These settings used to be called "hourly, daily, weekly, monthly" in older releases of rsnapshot, but were changed to "alpha, beta, gamma, delta" because the time interval between backups is arbitrary.

Setting this means I end up with 6 backups which were done most recently, then one of those gets hived off to become the beta backup, which it keeps 7 of, one of which gets hived off as gamma, and so on. This means you have multiple alpha backups fairly recently, multiple older beta backups representing days then gamma representing weeks and delta backups going back months. Set this according to how many backups you want to have.
<pre>
retain alpha 6
retain beta 7
retain gamma 4
retain delta 3
</pre>
And what to backup:
<pre>
# Local
backup /home/ local/
backup /etc/ local/

# Remote
backup user@remote:/home/user/ remote/ exclude=/home/user/Downloads
</pre>
In this case, every 7th <samp>daily</samp> backup is saved as a <samp>weekly</samp> backup, every 4th <samp>weekly</samp> backup is retained as a <samp>monthly</samp> backup, and every 12th <samp>monthly</samp> backup is deleted. The folders <samp>/home</samp> and <samp>/etc</samp> from the local machine are backed up to <samp>/mnt/backup/local/</samp>, while it uses <samp>ssh</samp> to back up the folder <samp>/home/user</samp> on the machine <samp>remote</samp> to <samp>/mnt/backup/remote/</samp>. Make sure <samp>root</samp> has passwordless <samp>ssh</samp> access to the machines you want to backup over the internet (i.e. run <samp>ssh-keygen</samp> and <samp>ssh-copy-id</samp> as <samp>root</samp>). 
The last line also shows an example of how you can exclude parts of the location from backups.

== Testing ==
To test that your config file has the correct syntax:
<pre>
rsnapshot configtest
</pre>
To check what the system would do when running a backup without executing the commands, i.e. a dry run:
<pre>
rsnapshot -t alpha
rsnapshot -t beta
rsnapshot -t gamma
rsnapshot -t delta
</pre>
Finally, perform the first backup:
<pre>
rsnapshot alpha
</pre>
The last part might take a while. Subsequent backups should be much faster, as it will then only have to copy files that have changed since the last backup.

== Automation ==
After setting up and testing <samp>rsnapshot</samp> as described above, the next step is to make [[cron|<samp>cron</samp>]] automatically run <samp>rsnapshot</samp> at fixed intervals. The easiest way to achieve this is to create a few scripts in the folders <samp>/etc/periodic/*</samp> that <samp>crond</samp> monitors. The script below will write the appropriate contents to those files and make them executable:
<pre>
#!/bin/sh
cd /etc/periodic
dirs=("daily" "weekly" "monthly")

for dir in "${dirs[@]}"; do
echo -e "#!/bin/sh\nexec /usr/bin/rsnapshot $dir" > "$dir/rsnapshot"
chmod +x "$dir/rsnapshot"
done

</pre>

{{Cat|/etc/periodic/daily/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot daily
}}

{{Cat|/etc/periodic/weekly/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot weekly
}}

{{Cat|/etc/periodic/monthly/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot monthly
}}

Remember to make the scripts executable:
<pre>
chmod +x /etc/periodic/*/rsnapshot
</pre>
After that, test that the scripts work as expected:
<pre>
run-parts /etc/periodic/daily
run-parts /etc/periodic/weekly
run-parts /etc/periodic/monthly
</pre>
Assuming <samp>crond</samp> is set to start at boot (the default), your system should now make backups automatically.

[[Category:System Administration]]

Rsnapshot

2023-04-18T22:31:37Z

Jahway603: Updated with new options for retain BACKUP LEVELS / INTERVALS

[http://rsnapshot.org/ <samp>rsnapshot</samp>] is a filesystem backup utility based on [[rsync|<samp>rsync</samp>]]. Using <samp>rsnapshot</samp>, it is possible to take snapshots of your filesystems at different points in time. Using hard links, rsnapshot creates the illusion of multiple full backups, while only taking up the space of one full backup plus differences. When coupled with <samp>ssh</samp>, it is possible to take snapshots of remote filesystems as well. This document is a tutorial on the installation and configuration of rsnapshot.

== Installation ==
To install rsnapshot:
<pre>
apk add rsnapshot
</pre>

== Configuration ==
To configure <samp>rsnapshot</samp>, copy the example configuration <samp>/etc/rsnapshot.conf.default</samp> to <samp>/etc/rsnapshot.conf</samp>, and edit it to your needs based on the comments and the [http://rsnapshot.org/rsnapshot/docs/docbook/rest.html official documentation]. Note that <samp>rsnapshot</samp> requires tabs between options and values in <samp>rsnapshot.conf</samp>. This is done so spaces can be included in filenames without requiring any extra escaping or quoting.

The most important parts to modify are where to store the backups:
<pre>
snapshot_root /mnt/backup
</pre>
How many backups to retain:

These settings used to be called "hourly, daily, weekly, monthly" in older releases of rsnapshot, but were changed to "alpha, beta, gamma, delta" because the time interval between backups is arbitrary.

Setting this means I end up with 6 backups which were done most recently, then one of those gets hived off to become the beta backup, which it keeps 7 of, one of which gets hived off as gamma, and so on. This means you have multiple alpha backups fairly recently, multiple older beta backups representing days then gamma representing weeks and delta backups going back months. Set this according to how many backups you want to have.
<pre>
retain alpha 6
retain beta 7
retain gamma 4
retain delta 3
</pre>
And what to backup:
<pre>
# Local
backup /home/ local/
backup /etc/ local/

# Remote
backup user@remote:/home/user/ remote/ exclude=/home/user/Downloads
</pre>
In this case, every 7th <samp>daily</samp> backup is saved as a <samp>weekly</samp> backup, every 4th <samp>weekly</samp> backup is retained as a <samp>monthly</samp> backup, and every 12th <samp>monthly</samp> backup is deleted. The folders <samp>/home</samp> and <samp>/etc</samp> from the local machine are backed up to <samp>/mnt/backup/local/</samp>, while it uses <samp>ssh</samp> to back up the folder <samp>/home/user</samp> on the machine <samp>remote</samp> to <samp>/mnt/backup/remote/</samp>. Make sure <samp>root</samp> has passwordless <samp>ssh</samp> access to the machines you want to backup over the internet (i.e. run <samp>ssh-keygen</samp> and <samp>ssh-copy-id</samp> as <samp>root</samp>). 
The last line also shows an example of how you can exclude parts of the location from backups.

== Testing ==
To test that your config file has the correct syntax:
<pre>
rsnapshot configtest
</pre>
To check what the system would do when running a backup without executing the commands, i.e. a dry run:
<pre>
rsnapshot -t daily
rsnapshot -t weekly
rsnapshot -t monthly
</pre>
Finally, perform the first backup:
<pre>
rsnapshot daily
</pre>
The last part might take a while. Subsequent backups should be much faster, as it will then only have to copy files that have changed since the last backup.

== Automation ==
After setting up and testing <samp>rsnapshot</samp> as described above, the next step is to make [[cron|<samp>cron</samp>]] automatically run <samp>rsnapshot</samp> at fixed intervals. The easiest way to achieve this is to create a few scripts in the folders <samp>/etc/periodic/*</samp> that <samp>crond</samp> monitors. The script below will write the appropriate contents to those files and make them executable:
<pre>
#!/bin/sh
cd /etc/periodic
dirs=("daily" "weekly" "monthly")

for dir in "${dirs[@]}"; do
echo -e "#!/bin/sh\nexec /usr/bin/rsnapshot $dir" > "$dir/rsnapshot"
chmod +x "$dir/rsnapshot"
done

</pre>

{{Cat|/etc/periodic/daily/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot daily
}}

{{Cat|/etc/periodic/weekly/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot weekly
}}

{{Cat|/etc/periodic/monthly/rsnapshot|#!/bin/sh

exec /usr/bin/rsnapshot monthly
}}

Remember to make the scripts executable:
<pre>
chmod +x /etc/periodic/*/rsnapshot
</pre>
After that, test that the scripts work as expected:
<pre>
run-parts /etc/periodic/daily
run-parts /etc/periodic/weekly
run-parts /etc/periodic/monthly
</pre>
Assuming <samp>crond</samp> is set to start at boot (the default), your system should now make backups automatically.

[[Category:System Administration]]

Talk:Rsnapshot

2023-04-18T21:28:51Z

Jahway603: rsnapshot retain options changed

== Change retain section ==

rsnapshot.conf does not use the same # BACKUP LEVELS / INTERVALS # as documented in this wiki article anymore.

From this Rockylinux rsnapshot setup link, https://docs.rockylinux.org/guides/backup/rsnapshot_backup/, we find the new retain options:
This has been changed from earlier versions of rsnapshot from "hourly, daily, monthly, yearly" to "alpha, beta, gamma, delta" which is a bit confusing.

TODO: Research what these are and document it in this wiki [[User:Jahway603|Jahway603]] ([[User talk:Jahway603|talk]]) 21:28, 18 April 2023 (UTC)