Merge branch 'develop' into release-docs
[akkoma] / docs / installation / releases_en.md
index c0eafa75afe6d145ce943e77cb5242611917c613..ce46d0d29fd44832207488889cbfc6e122499cfc 100644 (file)
@@ -12,10 +12,10 @@ While in theory OTP releases are possbile to install on any compatible machine,
 
 Paste the following into the shell:
 ```sh
-arch="$(arch)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;exit 1;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;exit 1;fi;echo "$arch$libc_postfix"
+arch="$(uname -m)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;fi;echo "$arch$libc_postfix"
 ```
 
-If your platform is supported the output will contain the flavour string, you will need it later. If not, this just means that we don't build releases for your platform, you can still try the regular install.
+If your platform is supported the output will contain the flavour string, you will need it later. If not, this just means that we don't build releases for your platform, you can still try installing from source.
 
 ### Installing the required packages
 
@@ -24,16 +24,18 @@ Other than things bundled in the OTP release Pleroma depends on:
 * unzip (needed to unpack release builds)
 * ncurses (ERTS won't run without it)
 * PostgreSQL (also utilizes extensions in postgresql-contrib)
-* nginx (could be swapped with another webserver but this guide covers only it)
+* nginx (could be swapped with another reverse proxy but this guide covers only it)
 * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
 
 Debian/Ubuntu:
 ```sh
-apt install curl unzip ncurses postgresql posqtgresql-contrib nginx certbot
+apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
 ```
 Alpine:
 ```sh
-apk add curl unzip ncurses postgresql posqtgresql-contrib nginx certbot
+echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
+apk update
+apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
 ```
 
 ## Setup
@@ -41,18 +43,17 @@ apk add curl unzip ncurses postgresql posqtgresql-contrib nginx certbot
 #### (Optional) Installing RUM indexes
 RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. You can read more about them on the [Configuration page](config.html#rum-indexing-for-full-text-search). They are completely optional and most of the time are not worth it, especially if you are running a single user instance (unless you absolutely need ordered search results).
 
-Debian/Ubuntu:
+Debian/Ubuntu (available only on Buster/19.04):
 ```sh
-apt install postgresql-rum
+apt install postgresql-11-rum
 ```
 Alpine:
 ```sh
-apk install gcc make
+apk add gcc make git postgresql-dev musl-dev
 git clone https://github.com/postgrespro/rum /tmp/rum
 cd /tmp/rum
 make USE_PGXS=1
 make USE_PGXS=1 install
-make USE_PGXS=1 installcheck
 cd
 rm -r /tmp/rum
 ```
@@ -70,7 +71,7 @@ rc-service postgresql restart
 ### Installing Pleroma
 ```sh
 # Create the Pleroma user
-adduser -S -s /bin/false -h /opt/pleroma -H pleroma
+adduser --system --shell  /bin/false --home /opt/pleroma pleroma
 
 # Set the flavour environment variable to the string you got in Detecting flavour section. 
 # For example if the flavour is `arm64-musl` the command will be
@@ -78,7 +79,6 @@ export FLAVOUR="arm64-musl"
 
 # Clone the release build into a temporary directory and unpack it
 su pleroma -s $SHELL -lc "
-echo '$FLAVOUR'
 curl 'https://git.pleroma.social/api/v4/projects/2/jobs/artifacts/master/download?job=$FLAVOUR' -o /tmp/pleroma.zip
 unzip /tmp/pleroma.zip -d /tmp/
 "
@@ -93,35 +93,41 @@ rm /tmp/pleroma.zip
 # Note: It does not have to be `/var/lib/pleroma/uploads`, the config generator will ask about the upload directory later
 
 mkdir -p /var/lib/pleroma/uploads
-chown -R pleroma:pleroma /var/lib/pleroma
+chown -R pleroma /var/lib/pleroma
 
 # Create custom public files directory (custom emojis, frontend bundle overrides, robots.txt, etc.)
 # Note: It does not have to be `/var/lib/pleroma/static`, the config generator will ask about the custom public files directory later
 mkdir -p /var/lib/pleroma/static
-chown -R pleroma:pleroma /var/lib/pleroma
+chown -R pleroma /var/lib/pleroma
 
 # Create a config directory
 mkdir -p /etc/pleroma
-chown -R pleroma:pleroma /etc/pleroma
+chown -R pleroma /etc/pleroma
 
 # Run the config generator
 su pleroma -s $SHELL -lc "./bin/pleroma_ctl instance gen --output /etc/pleroma/config.exs --output-psql /tmp/setup_db.psql"
 
 # Create the postgres database
-psql -U postgres -d postgres -f /tmp/setup_db.psql
+su postgres -s $SHELL -lc "psql -f /tmp/setup_db.psql"
+
+# If you have installed RUM indexes add
+# `config :pleroma, :database, rum_enabled: true`
+# to the end of /etc/pleroma/config.exs before proceeding
 
 # Create the database schema
-./bin/pleroma_ctl create
-./bin/pleroma_ctl migrate
+su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
+
+# If you have installed RUM indexes uncommend and run
+# su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
 
 # Start the instance to verify that everything is working as expected
-./bin/pleroma daemon
+su pleroma -s $SHELL -lc "./bin/pleroma daemon"
 
 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
 sleep 20 && curl http://localhost:4000/api/v1/instance
 
 # Stop the instance
-./bin/pleroma stop
+su pleroma -s $SHELL -lc "./bin/pleroma stop"
 ```
 
 ### Setting up nginx and getting Let's Encrypt SSL certificaties