Merge branch 'main' into patch-3

machinaeXphilip · Dec 18, 2022 · 86a90c7 · 86a90c7
2 parents cc99677 + 25c47c3
commit 86a90c7
Show file tree

Hide file tree

Showing 109 changed files with 1,740 additions and 2,329 deletions.
diff --git a/STYLE.md b/STYLE.md
@@ -25,6 +25,7 @@ isabell.uber.space
 
 -   Document all steps for setup. E.g. [create a database](https://github.com/Uberspace/lab/issues/39) when that's necessary. [Create directories](https://github.com/Uberspace/lab/issues/36) when needed.
 -   When there is a license needed for the software mention it.
+-   Include output of shell commands if there is any.
 -   If there are interactive shell sessions, emphasize the lines that expect input from the user. For example:
 
 ```
@@ -97,6 +98,7 @@ In our example this would be:
  command=env NODE_ENV=production /bin/node current/index.js
 ```
 
+-   If you're setting up a supervisord-service, make sure to include `startsecs=60` in the service definition.
 -   If you want to include links to https://manual.uberspace.de, please use the corresponding directives `manual` and `manual_anchor`. Use the `lab` and `lab_anchor` directives for linking other UberLab guides. Examples:
 
 ```

diff --git a/authorship/authorship/__init__.py b/authorship/authorship/__init__.py
@@ -207,7 +207,7 @@ def process_authorlists(app, doctree, fromdocname):
                 guides_list += link_entry
 
                 # I can't figure out a way to get the link and title from a page name..
-                link = guide + ".html"
+                link = '/' + guide + '.html'
                 title = guide.partition("_")[2].title()
 
                 link_wrapper = addnodes.compact_paragraph()

diff --git a/netlify.toml b/netlify.toml
@@ -1,3 +1,7 @@
+[build]
+  publish = "build/dirhtml"
+  command = "make dirhtml"
+
 [[redirects]]
   from = "/en/*"
   to = "/:splat"
diff --git a/requirements.txt b/requirements.txt
@@ -2,7 +2,7 @@
 feedgen==0.9.0
 pre-commit==2.13.*
 Sphinx==4.4.0
-sphinx-rtd-theme==1.0.*
 sphinx-autobuild==2021.3.*
 sphinx-notfound-page==0.3
+sphinx-rtd-theme==1.0.*
 sphinxcontrib-spelling==7.1.0
diff --git a/source/_static/images/cloudlog.png b/source/_static/images/cloudlog.png
diff --git a/source/_static/images/navidrome.png b/source/_static/images/navidrome.png
diff --git a/source/_static/images/ntfy.png b/source/_static/images/ntfy.png
diff --git a/source/_static/images/timetagger.svg b/source/_static/images/timetagger.svg
diff --git a/source/conf.py b/source/conf.py
@@ -88,10 +88,10 @@
 # By setting an empty string as the second tuple element, the display text
 # is the same as the target by default.
 extlinks = {
-    "manual": ("https://manual.uberspace.de/%s.html", ""),
+    "manual": ("https://manual.uberspace.de/%s", ""),
     "manual_anchor": ("https://manual.uberspace.de/%s", ""),
-    "lab": ("%s.html", ""),
-    "lab_anchor": ("%s", ""),
+    "lab": ("/%s", ""),
+    "lab_anchor": ("/%s", ""),
 }
 
 

diff --git a/source/guide_ackee.rst b/source/guide_ackee.rst
@@ -108,9 +108,17 @@ Create ``~/etc/services.d/ackee.ini`` with the following content:
   command=yarn start
   autostart=yes
   autorestart=yes
+  startsecs=30
 
 .. include:: includes/supervisord.rst
 
+Set a link to the log file destination so you can more easily access the logs:
+
+.. code-block:: console
+
+  [isabell@stardust html]$ ln --symbolic ~/.npm/_logs/ ~/logs/npm/
+  [isabell@stardust html]$
+
 Finishing installation
 ======================
 

diff --git a/source/guide_adminer.rst b/source/guide_adminer.rst
@@ -37,11 +37,11 @@ Adminer_ is released under `Apache License 2.0`_ or `GPL 2`_.
 Installation (with Plugin Support)
 ==================================
 
-Check the current version of Adminer at `GitHub <https://github.com/vrana/adminer/releases>`_ and go the the folder where you want Adminer to be installed.
+Check the current version of Adminer at `GitHub <https://github.com/vrana/adminer/releases>`_ and ``cd`` the your DocumentRoot:
 
 .. code-block:: console
 
-  [isabell@stardust ~]$ VERSION=4.7.8
+  [isabell@stardust ~]$ VERSION=4.8.1
   [isabell@stardust ~]$ cd ~/html
   [isabell@stardust html]$ wget -O adminer.php https://github.com/vrana/adminer/releases/download/v$VERSION/adminer-$VERSION.php
   [isabell@stardust html]$ mkdir -p plugins
@@ -118,6 +118,6 @@ Just repeat the installation steps with the new ``VERSION``.
 
 ----
 
-Tested with Adminer 4.7.8, Uberspace 7.8.0.0
+Tested with Adminer 4.8.1, Uberspace 7.13.0, and PHP 8.1
 
 .. author_list::
diff --git a/source/guide_akaunting.rst b/source/guide_akaunting.rst
@@ -129,6 +129,6 @@ You can update the installation in the update wizard which you can find in the A
 
 ----
 
-Tested with Akaunting 1.2.16, Uberspace 7.1.13
+Tested with Akaunting 3.0.9, Uberspace 7.13.0, and PHP 8.1
 
 .. author_list::
diff --git a/source/guide_ampache.rst b/source/guide_ampache.rst
@@ -43,11 +43,19 @@ Clone ampache code from github and install necessary dependencies with composer.
 
 .. code-block:: console
 
-  [isabell@stardust ~]$ cd ~/html
-  [isabell@stardust ~/html]$ git clone https://github.com/ampache/ampache.git
-  [isabell@stardust ~/html]$ cd ampache/
-  [isabell@stardust ~/html/ampache]$ composer install --prefer-source --no-interaction
-  [isabell@stardust ~]$
+  [isabell@stardust ~]$ cd /var/www/virtual/$USER/
+  [isabell@stardust isabell]$ git clone https://github.com/ampache/ampache.git
+  [isabell@stardust isabell]$ cd ampache/
+  [isabell@stardust ampache]$ composer install --prefer-source --no-interaction
+
+Remove your empty DocumentRoot and link Ampache's public folder instead:
+
+.. code-block:: console
+
+  [isabell@stardust ~]$ cd /var/www/virtual/$USER/
+  [isabell@stardust isabell]$ rm -f html/nocontent.html; rmdir html
+  [isabell@stardust isabell]$ ln -s ampache/public html
+  [isabell@stardust isabell]$
 
 
 Configuration
@@ -58,7 +66,7 @@ You will need to enter the following information:
 
 * Various
 
-  * Web Path: /ampache
+  * Web Path: /
 
 * Database Connection
 
@@ -90,6 +98,6 @@ If you want to upgrade from an older version of Ampache it is recommended moving
 
 ----
 
-Tested with Ampache v4.4.2 and Uberspace v7.11
+Tested with Ampache v5.5.5 and Uberspace v7.13, and PHP 8.1
 
 .. author_list::
diff --git a/source/guide_antragsgruen.rst b/source/guide_antragsgruen.rst
@@ -15,7 +15,7 @@ Antragsgrün
 
 .. tag_list::
 
-Antragsgrün_ is an open source web tool used by organizations such as the European and German Green Parties for discussing motions, amendments, and candidacies. It is written in PHP and distributed under the GPLv3 license.
+Antragsgrün_ is an open source web tool used by organisations such as the European and German Green Parties for discussing motions, amendments, and candidacies. It is written in PHP and distributed under the GPLv3 license.
 
 ----
 
@@ -32,8 +32,8 @@ Use the recommended :manual:`PHP <lang-php>` version as listed in the `system re
 
 .. code-block:: console
 
- [isabell@stardust ~]$ uberspace tools version use php 7.4
- Selected PHP version 7.4
+ [isabell@stardust ~]$ uberspace tools version use php 8.1
+ Selected PHP version 8.1
  The new configuration is adapted immediately. Patch updates will be applied automatically.
  [isabell@stardust ~]$
 
@@ -98,6 +98,6 @@ Use the built-in `web updater`_.
 ----
 
 
-Tested with Antragsgrün 4.8.1, Uberspace 7.11.5
+Tested with Antragsgrün 4.10.1, Uberspace 7.13.0, and PHP 8.1
 
 .. author_list::
diff --git a/source/guide_babybuddy.rst b/source/guide_babybuddy.rst
@@ -23,6 +23,12 @@ It is written in :manual:`Python <lang-python>` and based on the popular :lab:`D
 
 ----
 
+.. error::
+
+  This guide seems to be **broken** as it requires a newer version of Python. We would be
+  happy if you want to work on a solution and create a Pull Request.
+  See also the related issue: https://github.com/Uberspace/lab/issues/1184
+
 .. note:: For this guide you should be familiar with the basic concepts of
 
   * :manual:`Python <lang-python>` and its package manager :manual_anchor:`pip <lang-python.html#pip>`
@@ -50,7 +56,7 @@ You need `pipenv`_, a package manager/virtual environment tool for Python, so in
 
 ::
 
- [isabell@stardust ~]$ pip3.6 install pipenv --user
+ [isabell@stardust ~]$ pip3 install pipenv --user
  Collecting pipenv
    Downloading https://files.pythonhosted.org/packages/13/b4/3ffa55f77161cff9a5220f162670f7c5eb00df52e00939e203f601b0f579/pipenv-2018.11.26-py3-none-any.whl (5.2MB)
      100% |████████████████████████████████| 5.2MB 242kB/s
@@ -59,7 +65,12 @@ You need `pipenv`_, a package manager/virtual environment tool for Python, so in
    Downloading https://files.pythonhosted.org/packages/33/5d/314c760d4204f64e4a968275182b7751bd5c3249094757b39ba987dcfb5a/virtualenv-16.4.3-py2.py3-none-any.whl (2.0MB)
      100% |████████████████████████████████| 2.0MB 614kB/s
   […]
- [isabell@stardust ~]$
+
+.. note::
+
+    You have to install ``uwsgi`` with the same python version as the app.
+    Babybuddy now requires at least python 3.7.
+    E.g. if you use 3.9, install ``uwsgi`` with ``pip3.9 install uwsgi --user``
 
 .. include:: includes/install-uwsgi.rst
 
@@ -68,18 +79,18 @@ Installation
 
 Python
 ------
-During the installation process, you want to use Python in version 3.6. Set an alias for that:
+During the installation process, you want to use Python in version 3.7+. Set an alias for that:
 
 ::
 
- [isabell@stardust ~]$ alias python=python3.6
+ [isabell@stardust ~]$ alias python=python3.9
  [isabell@stardust ~]$ python --version
- Python 3.6.7
+ Python 3.9.13
  [isabell@stardust ~]$
 
 Database
 --------
-Baby Buddy will store its data in a :manual:`MySQL <database-mysql>` database. Create one with the name ``<username>_babybuddy``.
+Baby Buddy can store its data in a :manual:`MySQL <database-mysql>` database. Create one with the name ``<username>_babybuddy``.
 
 ::
 
@@ -113,25 +124,13 @@ Install all the requirements.
 ::
 
  [isabell@stardust ~]$ cd ~/babybuddy/public/
- [isabell@stardust public]$ pipenv install --python python3.6
+ [isabell@stardust public]$ pipenv install --python python3.9
  [...]
    🐍   ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 39/39 — 00:00:54
  To activate this project's virtualenv, run pipenv shell.
  Alternatively, run a command inside the virtualenv with pipenv run.
  [isabell@stardust ~/babybuddy/public]$
 
-Also, install the package ``mysqlclient``:
-
-::
-
- [isabell@stardust public]$ pipenv install mysqlclient
- [...]
-   🐍   ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 40/40 — 00:00:02
- To activate this project's virtualenv, run pipenv shell.
- Alternatively, run a command inside the virtualenv with pipenv run.
- [isabell@stardust public]$ cd
- [isabell@stardust ~]$
-
 Configuration
 -------------
 Copy the template configuration file and adapt it based on the following example.

diff --git a/source/guide_baikal.rst b/source/guide_baikal.rst
@@ -31,12 +31,12 @@ Baïkal_ is a lightweight CalDAV+CardDAV server.
 Prerequisites
 =============
 
-We’re using :manual:`PHP <lang-php>` in the stable version 7.4:
+We’re using :manual:`PHP <lang-php>` in the stable version 8.1:
 
 .. code-block:: console
 
  [isabell@stardust ~]$ uberspace tools version show php
- Using 'PHP' version: '7.4'
+ Using 'PHP' version: '8.1'
  [isabell@stardust ~]$
 
 Your website domain needs to be set up:
@@ -52,9 +52,9 @@ Remove your ``html`` directory and download the current version of Baïkal from
 
  [isabell@stardust ~]$ cd /var/www/virtual/$USER/
  [isabell@stardust isabell]$ rm -f html/nocontent.html; rmdir html
- [isabell@stardust isabell]$ wget https://github.com/sabre-io/Baikal/releases/download/0.7.2/baikal-0.7.2.zip
- [isabell@stardust isabell]$ unzip baikal-0.7.2.zip
- [isabell@stardust isabell]$ rm baikal-0.7.2.zip
+ [isabell@stardust isabell]$ wget https://github.com/sabre-io/Baikal/releases/download/0.9.2/baikal-0.9.2.zip
+ [isabell@stardust isabell]$ unzip baikal-0.9.2.zip
+ [isabell@stardust isabell]$ rm baikal-0.9.2.zip
  [isabell@stardust isabell]$ ln -s baikal/html html
  [isabell@stardust isabell]$
 
@@ -63,8 +63,6 @@ You can also choose not to replace your ``html`` directory (and e.g. install Ba
 Configuration
 =============
 
-Only if you didn't replace your ``html`` directory (and e.g. installed Baïkal in a subdirectory or under a subdomain), edit the file ``baikal/config/baikal.yaml`` and set the value of ``base_uri`` to ``'/'``.
-
 After the installation you need to open isabell.uber.space in your browser to finish your setup.
 
 Fill out your system settings, admin user and database settings, you can use the included SQLite database or :manual_anchor:`MySQL <database-mysql.html#login-credentials>`.
@@ -97,6 +95,6 @@ Finish the update by open isabell.uber.space in your browser.
 
 ----
 
-Tested with Baïkal_ 0.7.2 and Uberspace 7.8.1
+Tested with Baïkal_ 0.9.2, PHP 8.1 and Uberspace 7.13.0
 
 .. author_list::