Update install docs (#38)
[akkoma] / docs / installation / netbsd_en.md
index 6ad0de2f69cf44df9ddddf5f10c87af11da88c19..df05f0e963f998300910fcd7a7681a609050eaab 100644 (file)
@@ -1,16 +1,18 @@
 # Installing on NetBSD
 
 # Installing on NetBSD
 
-## Required software 
+{! backend/installation/generic_dependencies.include !}
+
+## Installing software used in this guide
 
 pkgin should have been installed by the NetBSD installer if you selected
 the right options. If it isn't installed, install it using pkg_add.
 
 Note that `postgresql11-contrib` is needed for the Postgres extensions
 
 pkgin should have been installed by the NetBSD installer if you selected
 the right options. If it isn't installed, install it using pkg_add.
 
 Note that `postgresql11-contrib` is needed for the Postgres extensions
-Pleroma uses.
+Akkoma uses.
 
 The `mksh` shell is needed to run the Elixir `mix` script.
 
 
 The `mksh` shell is needed to run the Elixir `mix` script.
 
-`# pkgin install acmesh elixir git-base git-docs mksh nginx postgresql11-server postgresql11-client postgresql11-contrib sudo`
+`# pkgin install acmesh elixir git-base git-docs mksh nginx postgresql11-server postgresql11-client postgresql11-contrib sudo ffmpeg4 ImageMagick`
 
 You can also build these packages using pkgsrc:
 ```
 
 You can also build these packages using pkgsrc:
 ```
@@ -44,30 +46,34 @@ pgsql=YES
 
 First, run `# /etc/rc.d/pgsql start`. Then, `$ sudo -Hu pgsql -g pgsql createdb`.
 
 
 First, run `# /etc/rc.d/pgsql start`. Then, `$ sudo -Hu pgsql -g pgsql createdb`.
 
-## Configuring Pleroma
+### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md))
+
+`# pkgin install ImageMagick ffmpeg4 p5-Image-ExifTool`
+
+## Configuring Akkoma
 
 
-Create a user for Pleroma:
+Create a user for Akkoma:
 
 ```
 
 ```
-# groupadd pleroma
-# useradd -d /home/pleroma -m -g pleroma -s /usr/pkg/bin/mksh pleroma
-# echo 'export LC_ALL="en_GB.UTF-8"' >> /home/pleroma/.profile
-# su -l pleroma -c $SHELL
+# groupadd akkoma
+# useradd -d /home/akkoma -m -g akkoma -s /usr/pkg/bin/mksh akkoma
+# echo 'export LC_ALL="en_GB.UTF-8"' >> /home/akkoma/.profile
+# su -l akkoma -c $SHELL
 ```
 
 Clone the repository:
 
 ```
 ```
 
 Clone the repository:
 
 ```
-$ cd /home/pleroma
-$ git clone -b stable https://git.pleroma.social/pleroma/pleroma.git
+$ cd /home/akkoma
+$ git clone https://akkoma.dev/AkkomaGang/akkoma.git
 ```
 
 ```
 
-Configure Pleroma. Note that you need a domain name at this point:
+Configure Akkoma. Note that you need a domain name at this point:
 
 ```
 
 ```
-$ cd /home/pleroma/pleroma
+$ cd /home/akkoma/akkoma
 $ mix deps.get
 $ mix deps.get
-$ mix pleroma.instance gen # You will be asked a few questions here.
+$ MIX_ENV=prod mix pleroma.instance gen # You will be asked a few questions here.
 ```
 
 Since Postgres is configured, we can now initialize the database. There should
 ```
 
 Since Postgres is configured, we can now initialize the database. There should
@@ -95,7 +101,7 @@ $ MIX_ENV=prod mix ecto.migrate
 ## Configuring nginx
 
 Install the example configuration file
 ## Configuring nginx
 
 Install the example configuration file
-`/home/pleroma/pleroma/installation/pleroma.nginx` to
+`/home/akkoma/akkoma/installation/akkoma.nginx` to
 `/usr/pkg/etc/nginx.conf`.
 
 Note that it will need to be wrapped in a `http {}` block. You should add
 `/usr/pkg/etc/nginx.conf`.
 
 Note that it will need to be wrapped in a `http {}` block. You should add
@@ -166,31 +172,29 @@ Let's add auto-renewal to `/etc/daily.local`
     --stateless
 ```
 
     --stateless
 ```
 
-## Creating a startup script for Pleroma
+## Creating a startup script for Akkoma
 
 Copy the startup script to the correct location and make sure it's executable:
 
 ```
 
 Copy the startup script to the correct location and make sure it's executable:
 
 ```
-# cp /home/pleroma/pleroma/installation/netbsd/rc.d/pleroma /etc/rc.d/pleroma
-# chmod +x /etc/rc.d/pleroma
+# cp /home/akkoma/akkoma/installation/netbsd/rc.d/akkoma /etc/rc.d/akkoma
+# chmod +x /etc/rc.d/akkoma
 ```
 
 Add the following to `/etc/rc.conf`:
 
 ```
 ```
 
 Add the following to `/etc/rc.conf`:
 
 ```
-pleroma=YES
-pleroma_home="/home/pleroma"
-pleroma_user="pleroma"
+akkoma=YES
+akkoma_home="/home/akkoma"
+akkoma_user="akkoma"
 ```
 
 ```
 
-Run `# /etc/rc.d/pleroma start` to start Pleroma.
+Run `# /etc/rc.d/akkoma start` to start Akkoma.
 
 ## Conclusion
 
 Restart nginx with `# /etc/rc.d/nginx restart` and you should be up and running.
 
 
 ## Conclusion
 
 Restart nginx with `# /etc/rc.d/nginx restart` and you should be up and running.
 
-If you need further help, contact niaa on freenode.
-
 Make sure your time is in sync, or other instances will receive your posts with
 incorrect timestamps. You should have ntpd running.
 
 Make sure your time is in sync, or other instances will receive your posts with
 incorrect timestamps. You should have ntpd running.
 
@@ -204,4 +208,7 @@ incorrect timestamps. You should have ntpd running.
 
 ## Questions
 
 
 ## Questions
 
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.
+Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.
+## Questions
+
+If you encounter any issues or have questions regarding the install process, feel free to ask at [meta.akkoma.dev](https://meta.akkoma.dev/).