From bdd22a4c9841a3ebecaf14c1d0b17fe803db359c Mon Sep 17 00:00:00 2001 From: "Dr. Tobias Quathamer" Date: Wed, 30 Oct 2024 13:38:40 +0100 Subject: [PATCH] Update PyPI packages, fix errors and warnings (#1823) * Update PiPy dependencies * The extlinks extension expects None instead of an empty string * Set language to a defined value, None is no longer supported * html_theme_path is no longer needed and raises a warning now * Remove display_version option. This is deprecated since version 3.0.0: Removed in favor of version_selector and language_selector. * Direct use of the spelling directive is deprecated, use ".. spelling:word-list::" * Fix critical error: Incomplete section title. * Fix error: Anonymous hyperlink mismatch: 1 references but 0 targets. * Fix errors due to wrong formatting of code block * Fix error: Content block expected for the "sidebar" directive; none found. [docutils] * Fix error: Unexpected indentation. [docutils] * Fix warning: Title overline/underline too short. * Fix warning: line number spec is out of range * Fix warning: Inline interpreted text or phrase reference start-string without end-string. * Fix warning: line number spec is out of range and remove unnecessary emphasis * Fix warning: correctly indent nested lists * Fix warning: Literal block expected; none found. * Fix warning: line number spec is out of range and remove unnecessary emphasis * Fix warning: Literal block expected; none found. * Fix warning: Use valid JSON for correct markup The warning is: Lexing literal_block 'storage: ...' as "json" resulted in an error at token: 's'. * Fix warning: undefined label: 'download latest release and extract' * Fix warning: Pygments Lexer Name 'txt' is unknown * Include howto_upgrade_node_apps, which was not includeed in any toctree * Fix warning: Enumerated list ends without a blank line; unexpected unindent. --- requirements.txt | 18 +++++++++--------- source/conf.py | 22 +++++++++++++--------- source/guide_actual.rst | 2 +- source/guide_bludit.rst | 4 ++-- source/guide_buildbot.rst | 2 +- source/guide_chezscheme.rst | 2 +- source/guide_dendrite.rst | 3 --- source/guide_dokuwiki.rst | 2 +- source/guide_easyappointments.rst | 2 +- source/guide_ethercalc.rst | 2 +- source/guide_fittrackee.rst | 2 +- source/guide_focalboard.rst | 2 +- source/guide_gancio.rst | 6 +++--- source/guide_gitea.rst | 2 +- source/guide_goatcounter.rst | 4 ++-- source/guide_gotosocial.rst | 2 +- source/guide_grafana-mimir.rst | 10 +++++----- source/guide_hasteserver.rst | 24 ++++++++++++++---------- source/guide_homebox.rst | 4 +++- source/guide_jenkins.rst | 2 +- source/guide_keycloak.rst | 2 +- source/guide_kimai.rst | 1 - source/guide_kirby.rst | 2 +- source/guide_libreoffice.rst | 2 +- source/guide_linkace.rst | 8 -------- source/guide_mailman-3.rst | 2 +- source/guide_moodle.rst | 4 +++- source/guide_mosh.rst | 2 +- source/guide_msmtp.rst | 2 +- source/guide_offen.rst | 2 +- source/guide_onionservice.rst | 16 +++++++++------- source/guide_openwebanalytics.rst | 2 +- source/guide_otree.rst | 8 ++++---- source/guide_passbolt.rst | 2 -- source/guide_pleroma.rst | 2 +- source/guide_prometheus.rst | 2 +- source/guide_starlette.rst | 4 ++-- source/guide_sulu.rst | 2 +- source/guide_teamspeak.rst | 2 +- source/guide_textpattern.rst | 4 ++-- source/guide_uptime-kuma.rst | 2 +- source/guide_wishthis.rst | 10 ++-------- source/guide_wkd.rst | 2 +- source/guide_wordpress.rst | 2 +- source/howto_automatic-deployment.rst | 3 +-- source/howto_ssh-keys.rst | 2 +- source/howto_upgrade_node_apps.rst | 10 +++++----- source/index.rst | 1 + 48 files changed, 107 insertions(+), 113 deletions(-) diff --git a/requirements.txt b/requirements.txt index da3d67ec1..3af34b89e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,14 +1,14 @@ -e ./authorship -feedgen==0.9.0 +feedgen==1.0.0 pre-commit==3.5.* -Sphinx==4.4.0 -sphinx-autobuild==2021.3.* -sphinx-notfound-page==0.3 -sphinx-rtd-theme==1.0.* -sphinxcontrib-applehelp==1.0.2 +Sphinx==7.1.2 +sphinx-autobuild==2021.03.* +sphinx-notfound-page==1.0.4 +sphinx-rtd-theme==3.0.1 +sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 -sphinxcontrib-htmlhelp==2.0.0 -sphinxcontrib-mermaid==0.9.2 +sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-mermaid==1.0.0 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 -sphinxcontrib-spelling==7.1.0 +sphinxcontrib-spelling==8.0.0 diff --git a/source/conf.py b/source/conf.py index c80fbda7f..a492dcb24 100644 --- a/source/conf.py +++ b/source/conf.py @@ -19,6 +19,12 @@ # import os # import sys # sys.path.insert(0, os.path.abspath('.')) +# +# Running flake reports that sphinx_rtd_theme is imported, +# but not used. This is a false positive, so ignore that +# specific error in this file. +# +# flake8: noqa F401 import sphinx_rtd_theme # -- General configuration ------------------------------------------------ @@ -71,7 +77,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en_GB" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -86,13 +92,13 @@ # Configure the `extlinks` extension to handle the `manual` and `lab` # directives. -# By setting an empty string as the second tuple element, the display text -# is the same as the target by default. +# The second tuple element is the link caption. By using None, the caption +# is the full URL. extlinks = { - "manual": ("https://manual.uberspace.de/%s", ""), - "manual_anchor": ("https://manual.uberspace.de/%s", ""), - "lab": ("/%s", ""), - "lab_anchor": ("/%s", ""), + "manual": ("https://manual.uberspace.de/%s", None), + "manual_anchor": ("https://manual.uberspace.de/%s", None), + "lab": ("/%s", None), + "lab_anchor": ("/%s", None), } @@ -100,11 +106,9 @@ html_theme = "sphinx_rtd_theme" html_theme_options = { - "display_version": False, "navigation_depth": 2, "collapse_navigation": True, } -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] html_last_updated_fmt = "%b %d, %Y" html_context = { "display_github": True, diff --git a/source/guide_actual.rst b/source/guide_actual.rst index 7af88525f..a7fcdddaf 100644 --- a/source/guide_actual.rst +++ b/source/guide_actual.rst @@ -126,7 +126,7 @@ When a new Actual release is published, follow these steps to update: 3. Run ``git pull`` from the directory you cloned the project into. This will download the latest server code. 4. Replace the version of the bcrypt dependency as described above. 5. Run ``yarn install --refresh-lockfile`` from that same directory. -This will download the latest web client code, along with any updated dependencies for the server. + This will download the latest web client code, along with any updated dependencies for the server. 6. Restart the server by running ``supervisorctl start actual``. .. code-block:: bash diff --git a/source/guide_bludit.rst b/source/guide_bludit.rst index 02dcf723a..ebd3de3a5 100644 --- a/source/guide_bludit.rst +++ b/source/guide_bludit.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: bg BG @@ -59,7 +59,7 @@ Your blog domain needs to be setup: Installation ============ -``cd`` to your :manual:`document root `, then download the latest version of Bludit from Github__. +``cd`` to your :manual:`document root `, then download the latest version of Bludit from Github_. .. code-block:: console :emphasize-lines: 1,2 diff --git a/source/guide_buildbot.rst b/source/guide_buildbot.rst index 4eceef1d6..c9e43bbdb 100644 --- a/source/guide_buildbot.rst +++ b/source/guide_buildbot.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: Pohl .. author:: Thomas Hoffmann diff --git a/source/guide_chezscheme.rst b/source/guide_chezscheme.rst index ab721c0e2..52c70862c 100644 --- a/source/guide_chezscheme.rst +++ b/source/guide_chezscheme.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: Chez .. author:: luto diff --git a/source/guide_dendrite.rst b/source/guide_dendrite.rst index 25edbf287..2e6191790 100644 --- a/source/guide_dendrite.rst +++ b/source/guide_dendrite.rst @@ -6,9 +6,6 @@ .. highlight:: console -.. sidebar:: Logo - - ######## Dendrite ######## diff --git a/source/guide_dokuwiki.rst b/source/guide_dokuwiki.rst index a538bb93f..9addb72f5 100644 --- a/source/guide_dokuwiki.rst +++ b/source/guide_dokuwiki.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: superduper .. author:: Christian Kantelberg diff --git a/source/guide_easyappointments.rst b/source/guide_easyappointments.rst index 33d755fc4..da0e235a5 100644 --- a/source/guide_easyappointments.rst +++ b/source/guide_easyappointments.rst @@ -1,6 +1,6 @@ .. author:: Lukas Herzog -.. spelling:: +.. spelling:word-list:: Tselegidis english french diff --git a/source/guide_ethercalc.rst b/source/guide_ethercalc.rst index 44f51f899..8cc8685c0 100644 --- a/source/guide_ethercalc.rst +++ b/source/guide_ethercalc.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: Nodemule .. author:: Achim | pxlfrk diff --git a/source/guide_fittrackee.rst b/source/guide_fittrackee.rst index 000500fc9..c2a33e4b7 100644 --- a/source/guide_fittrackee.rst +++ b/source/guide_fittrackee.rst @@ -119,7 +119,7 @@ Optional: Redis We need Redis for task queue (if email sending is enabled and for data export requests) and API rate limits. -Please follow the :lab:`Redis ` guide to setup redis with one variation: By default, Redis does not run on a port with us, but provides a Unix socket under ``/home/$USER/.redis/sock``. Either one has to adjust the configuration of the Fittrackee application or change the Redis configuration from `port 0' to 6379. +Please follow the :lab:`Redis ` guide to setup redis with one variation: By default, Redis does not run on a port with us, but provides a Unix socket under ``/home/$USER/.redis/sock``. Either one has to adjust the configuration of the Fittrackee application or change the Redis configuration from 'port 0' to 6379. Optional: Emails ---------------- diff --git a/source/guide_focalboard.rst b/source/guide_focalboard.rst index d8219562e..6a4e60769 100644 --- a/source/guide_focalboard.rst +++ b/source/guide_focalboard.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: cr .. author:: Thomas Johnson diff --git a/source/guide_gancio.rst b/source/guide_gancio.rst index 61f109e33..3da82a4f0 100644 --- a/source/guide_gancio.rst +++ b/source/guide_gancio.rst @@ -46,7 +46,7 @@ Prerequisites Gancio v1.6.14 is running with node 14=> and 18=<. .. code-block:: console - :emphasize-lines:1, 7 + :emphasize-lines: 1,7 [isabell@stardust ~]$ uberspace tools version list node - 12 @@ -66,7 +66,6 @@ Installation We will install gancio using yarn: .. code-block:: console - :emphasize-lines: 1 [isabell@stardust ~]$ yarn global add --network-timeout 1000000000 --silent https://gancio.org/latest.tgz @@ -109,7 +108,8 @@ Updates ======= .. code-block:: console - :emphasize-lines:1, 6, 10, 11 + :emphasize-lines: 1,6,10,11 + [isabell@stardust ~]$ yarn global remove gancio [1/2] Removing module gancio... [2/2] Regenerating lockfile and installing missing dependencies... diff --git a/source/guide_gitea.rst b/source/guide_gitea.rst index ec1a85605..fdc2f5e74 100644 --- a/source/guide_gitea.rst +++ b/source/guide_gitea.rst @@ -13,7 +13,7 @@ .. image:: _static/images/gitea.png :align: center -.. spelling:: +.. spelling:word-list:: repos ##### diff --git a/source/guide_goatcounter.rst b/source/guide_goatcounter.rst index ab46725dc..ace51c167 100644 --- a/source/guide_goatcounter.rst +++ b/source/guide_goatcounter.rst @@ -11,9 +11,9 @@ .. image:: _static/images/goatcounter.svg :align: center -#### +########### Goatcounter -#### +########### .. tag_list:: diff --git a/source/guide_gotosocial.rst b/source/guide_gotosocial.rst index a2ff2e4bc..e932f8dc6 100644 --- a/source/guide_gotosocial.rst +++ b/source/guide_gotosocial.rst @@ -1,7 +1,7 @@ .. highlight:: console .. author:: this.ven -.. spelling:: +.. spelling:word-list:: pleroma .. tag:: golang diff --git a/source/guide_grafana-mimir.rst b/source/guide_grafana-mimir.rst index 514e1bc82..3c909c907 100644 --- a/source/guide_grafana-mimir.rst +++ b/source/guide_grafana-mimir.rst @@ -84,7 +84,7 @@ Directory for storing the custom configuration files: Mimir installation -================= +================== Find the latest version of `Mimir `_ at GitHub and download the latest Linux binary (`mimir-linux-amd64`): @@ -97,7 +97,7 @@ Find the latest version of `Mimir `_ at GitHub and download the Mimir Configuration ------------------- +------------------- Create the file ``~/etc/mimir/mimir.yaml`` with the following content: @@ -198,7 +198,7 @@ What the arguments for mimir mean: * ``-config.file``: The location of the custom configuration file we created. Connecting Grafana to Mimir --------------------------- +--------------------------- .. note:: At that point, you already should have installed :lab:`Grafana `. @@ -231,7 +231,7 @@ Find the latest version of `Grafana Agent `_ at GitHub. Grafana Agent configuration ----------------------- +--------------------------- Grafana Agent uses the "River" format for configuration files. You can find documentation about this format `here `_. Create the file ``~/etc/grafana-agent/grafana-agent.river`` with the following basic configuration: @@ -308,7 +308,7 @@ Finishing installation ====================== Start Mimir and Grafana Agent ------------------------ +----------------------------- .. include:: includes/supervisord.rst diff --git a/source/guide_hasteserver.rst b/source/guide_hasteserver.rst index bc6d4672e..f6425274f 100644 --- a/source/guide_hasteserver.rst +++ b/source/guide_hasteserver.rst @@ -120,12 +120,14 @@ Once you've done that, your config section for storage should look like: .. code-block:: json - storage: { - "type": "redis", - "host": "localhost", - "port": 6379, - "db": 0 - }, + { + "storage": { + "type": "redis", + "host": "localhost", + "port": 6379, + "db": 0 + }, + } If your Redis server is configured for password authentication, use the ``password`` field. @@ -176,10 +178,12 @@ Once you've done that, your config section for storage should look like: .. code-block:: json - storage: { - "type": "postgres", - "connectionUrl": "postgres://haste:password@localhost:5432/haste" - }, + { + "storage": { + "type": "postgres", + "connectionUrl": "postgres://haste:password@localhost:5432/haste" + }, + } Replace ``password`` with the password of user haste. diff --git a/source/guide_homebox.rst b/source/guide_homebox.rst index 0ff2e4ff7..a07df8bf4 100644 --- a/source/guide_homebox.rst +++ b/source/guide_homebox.rst @@ -60,6 +60,8 @@ The official documentation_ recommends using Docker, but since Uberspace doesn't support Docker and the Docker container doesn't do that much we set up the application as a :manual:`supervisord ` process. +.. _download-latest-release-and-extract: + Download latest release and extract ----------------------------------- @@ -134,7 +136,7 @@ Then restart the service Updates ======= -To update Homebox repeat the steps described in :ref:`Download latest release and extract`. +To update Homebox repeat the steps described in :ref:`download-latest-release-and-extract`. After updating the binary tell :manual:`supervisord ` to restart the service: .. code-block:: console diff --git a/source/guide_jenkins.rst b/source/guide_jenkins.rst index de992ab99..e1a1146c3 100644 --- a/source/guide_jenkins.rst +++ b/source/guide_jenkins.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: sbt .. author:: Raphael Höser diff --git a/source/guide_keycloak.rst b/source/guide_keycloak.rst index ba4e43370..af5f8c2fb 100644 --- a/source/guide_keycloak.rst +++ b/source/guide_keycloak.rst @@ -6,7 +6,7 @@ .. tag:: sso .. tag:: lang-java -.. spelling:: +.. spelling:word-list:: Keycloak .. sidebar:: Logo diff --git a/source/guide_kimai.rst b/source/guide_kimai.rst index f131269d6..365f0e745 100644 --- a/source/guide_kimai.rst +++ b/source/guide_kimai.rst @@ -165,7 +165,6 @@ Now clear and warmup your cache. And last but not least: upgrade your database (you need to confirm the migration). .. code-block:: console - :emphasize-lines: 4 [isabell@stardust kimai]$ bin/console kimai:update -n [isabell@stardust ~]$ diff --git a/source/guide_kirby.rst b/source/guide_kirby.rst index c08c69601..048801c9e 100644 --- a/source/guide_kirby.rst +++ b/source/guide_kirby.rst @@ -1,6 +1,6 @@ .. author:: Daniel Kratz -.. spelling:: +.. spelling:word-list:: Allgeier .. tag:: lang-php diff --git a/source/guide_libreoffice.rst b/source/guide_libreoffice.rst index e97d57b12..3d355a153 100644 --- a/source/guide_libreoffice.rst +++ b/source/guide_libreoffice.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: memproportion .. author:: jorsn diff --git a/source/guide_linkace.rst b/source/guide_linkace.rst index 347d4f744..6b148ba1d 100644 --- a/source/guide_linkace.rst +++ b/source/guide_linkace.rst @@ -32,7 +32,6 @@ Prerequisites We’re using :manual:`PHP ` in the stable version 8.2: .. code-block:: console - :emphasize-lines: 1 [isabell@stardust ~]$ uberspace tools version use php 8.2 Selected PHP version 8.2 @@ -50,7 +49,6 @@ Installation ``cd`` to the directory one level above your :manual:`DocumentRoot `, then download LinkAce. You can find the latest version on the `release page`_, replace the version below with the version number. .. code-block:: console - :emphasize-lines: 1,2,3,6,7 [isabell@stardust ~]$ cd /var/www/virtual/$USER/ [isabell@stardust isabell]$ wget https://github.com/Kovah/LinkAce/releases/download/v1.13.0/linkace-v1.13.0.zip @@ -63,7 +61,6 @@ Installation After the installation has finished, remove your unused :manual:`DocumentRoot ` and create a new symbolic link to the ``linkace/public`` directory. .. code-block:: console - :emphasize-lines: 1,2,3 [isabell@stardust ~]$ cd /var/www/virtual/$USER/ [isabell@stardust isabell]$ rm -f html/nocontent.html; rmdir html @@ -79,7 +76,6 @@ Set up a database Run the following code to create the database ``_linkace`` in MySQL: .. code-block:: console - :emphasize-lines: 1 [isabell@stardust ~]$ mysql -e "CREATE DATABASE ${USER}_linkace COLLATE utf8mb4_bin;" [isabell@stardust ~]$ @@ -92,7 +88,6 @@ Create the .env file Create a copy of the .env.example file and name it .env .. code-block:: console - :emphasize-lines: 1,2 [isabell@stardust ~]$ cd /var/www/virtual/$USER/linkace [isabell@stardust linkace]$ cp .env.example .env @@ -104,7 +99,6 @@ Generate a secret key Run the following command to generate a secret key for your application and prepare LinkAce for the setup: .. code-block:: console - :emphasize-lines: 1,2 [isabell@stardust ~]$ cd /var/www/virtual/$USER/linkace [isabell@stardust linkace]$ php artisan key:generate @@ -121,7 +115,6 @@ Updates Check LinkAce's `release page`_ for the latest version. If a newer version is available, download the package. Overwrite all existing files with the new ones. .. code-block:: console - :emphasize-lines: 1,2,3,6,7 [isabell@stardust ~]$ cd /var/www/virtual/$USER/ [isabell@stardust isabell]$ wget https://github.com/Kovah/LinkAce/releases/download/vx.x.x/linkace-vx.x.x.zip @@ -133,7 +126,6 @@ Check LinkAce's `release page`_ for the latest version. If a newer version is av Run the database migrations which are needed after all updates and delete the current cache: .. code-block:: console - :emphasize-lines: 1,2,3 [isabell@stardust ~]$ cd /var/www/virtual/$USER/linkace [isabell@stardust linkace]$ php artisan migrate diff --git a/source/guide_mailman-3.rst b/source/guide_mailman-3.rst index a1bcb0bda..9b2d57de1 100644 --- a/source/guide_mailman-3.rst +++ b/source/guide_mailman-3.rst @@ -535,7 +535,7 @@ Install cronjobs Setup fetchmail -============= +=============== Next, we add a ``fetchmailrc`` to, e.g., ``~/etc/fetchmailrc`` This file may look like this: diff --git a/source/guide_moodle.rst b/source/guide_moodle.rst index d42f7d2cb..f583359fd 100644 --- a/source/guide_moodle.rst +++ b/source/guide_moodle.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: Et voilà @@ -125,10 +125,12 @@ Visit your Uberspace domain in the browser of our choice – in this case ``isab 2. For the Data directory, choose the directory you created: ``/home/isabell/moodledata``. 3. For the Database driver, choose "MariaDB (native/mariadb)". 4. For the Database Settings, enter your information: + 1. Database name: ``isabell_moodle`` 2. Database user: ``isabell`` 3. Database password: ``MySuperSecretPassword`` 4. Database port: ``3306`` + 5. Read the copyright notice and only accept if you truly do. 🙂 6. All checks should be OK. At the end of the page, click "Continue". 7. This could take a while to finish. You should be redirected to the process page. Here you can watch the process while installing missing plugins. After all installations have finished, at the end of the page, click "Continue". diff --git a/source/guide_mosh.rst b/source/guide_mosh.rst index 94d711b14..61975d422 100644 --- a/source/guide_mosh.rst +++ b/source/guide_mosh.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: Wi Fi diff --git a/source/guide_msmtp.rst b/source/guide_msmtp.rst index f97720111..deca3d1c6 100644 --- a/source/guide_msmtp.rst +++ b/source/guide_msmtp.rst @@ -142,7 +142,7 @@ Example Configuration Test your configuarion -------------------- +---------------------- .. code-block:: console diff --git a/source/guide_offen.rst b/source/guide_offen.rst index dfedf3b70..358803b7f 100644 --- a/source/guide_offen.rst +++ b/source/guide_offen.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: Offen offen diff --git a/source/guide_onionservice.rst b/source/guide_onionservice.rst index b95d564b3..1bc5e74d9 100644 --- a/source/guide_onionservice.rst +++ b/source/guide_onionservice.rst @@ -5,13 +5,9 @@ .. categorize your guide! refer to the current list of tags: https://lab.uberspace.de/tags .. tag:: web -.. sidebar:: About - - - -########## +################# Tor onion service -########## +################# .. tag_list:: @@ -39,6 +35,7 @@ Download tor ------------------- Go to the tor download_ page and copy the download link for the latest stable version of the tor expert bundle for the OS GNU/Linux (x86_64) + :: [isabell@stardust ~]$ curl --proto '=https' --tlsv1.2 -sSf https://archive.torproject.org/tor-package-archive/torbrowser/13.0.8/tor-expert-bundle-linux-x86_64-13.0.8.tar.gz -o tor.tar.gz [isabell@stardust ~]$ tar xvzf tor.tar.gz @@ -58,9 +55,10 @@ Configuration ============= Configure tor as onion service ------------------------- +------------------------------ Create the file ``~/tor/torrc`` and add the following lines: + :: HiddenServiceDir onionservice HiddenServicePort 80 127.0.0.1:80 @@ -73,6 +71,7 @@ This directory contains the cryptographic keys of the onion service and should n Do not remove or modify the ``ExitPolicy``. Uberspace does not allow Tor exit nodes. Optionally you can test if everything works by starting the tor daemon directly from the shell. If tor in configured correctly the output should look like this: + :: [isabell@stardust ~]$ LD_LIBRARY_PATH=~/tor ~/tor/tor --torrc-file tor/torrc [notice] Opening Socks listener on 127.0.0.1:9050 @@ -96,6 +95,7 @@ Set up the daemon Create the file ``~/etc/services.d/tor-onion-service.ini`` with the following content: + :: [program:tor-onion-service] command=%(ENV_HOME)s/tor/tor --torrc-file %(ENV_HOME)s/tor/torrc @@ -111,6 +111,7 @@ Finishing installation .. include:: includes/supervisord.rst To view your automatically generated .onion hostname + :: [isabell@stardust ~]$ cat ~/onionservice/hostname jv2h7lm5tir5dsr6ihqmut6elusip3ylef46lhaq6q3gsv5pi7ddrwqd.onion @@ -153,6 +154,7 @@ Debugging If something fails with this specific error, you should have a look at this specific config, or just reload that service. Try to look into the log at this path. If the service fails to start you can start the tor binary directly to see the thr error messages: + :: [isabell@stardust ~]$ LD_LIBRARY_PATH=~/tor ~/tor/tor --torrc-file tor/torrc [isabell@stardust ~]$. diff --git a/source/guide_openwebanalytics.rst b/source/guide_openwebanalytics.rst index 7757d07b1..b872b5077 100644 --- a/source/guide_openwebanalytics.rst +++ b/source/guide_openwebanalytics.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: owa .. author:: Thomas Johnson diff --git a/source/guide_otree.rst b/source/guide_otree.rst index 2f1cdcd5b..5cdd8bc19 100644 --- a/source/guide_otree.rst +++ b/source/guide_otree.rst @@ -67,7 +67,7 @@ Setup a domain to access your oTree apps: Web backend ----------- +----------- .. include:: includes/web-backend.rst @@ -103,10 +103,10 @@ Second, install otree and its dependencies: (venv) [isabell@stardust otree]$ Configuration -============ +============= oTree ----------- +----- If you already have an oTree project, you should copy it into the ``otree`` directory. If you don't have an oTree project yet, you can create one with: @@ -150,7 +150,7 @@ You can now exit the virtual environment with: Set up the daemon ----------- +----------------- Before running oTree in production, generate up to three additional secret keys, depending on your needs: diff --git a/source/guide_passbolt.rst b/source/guide_passbolt.rst index 5370fe384..097d4610c 100644 --- a/source/guide_passbolt.rst +++ b/source/guide_passbolt.rst @@ -111,8 +111,6 @@ Copy following content to ``gpg_batch.conf`` and replace ``YOUR_NAME``, ``YOUR_C %commit %echo done -:: - Save your fingerprint and replace ``SERVER_KEY@EMAIL.TEST`` with your email. ``gpg --batch --gen-key gpg_batch.conf`` will run for multiple minutes. Just wait until it's finished! :: diff --git a/source/guide_pleroma.rst b/source/guide_pleroma.rst index 27a6a62c8..5f14619ea 100644 --- a/source/guide_pleroma.rst +++ b/source/guide_pleroma.rst @@ -2,7 +2,7 @@ .. author:: Arian Malek .. author:: custompyramidfellow -.. spelling:: +.. spelling:word-list:: pleroma .. tag:: lang-elixir diff --git a/source/guide_prometheus.rst b/source/guide_prometheus.rst index 69e6ba7f0..67b590691 100644 --- a/source/guide_prometheus.rst +++ b/source/guide_prometheus.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: prometheus .. author:: Malte Krupa diff --git a/source/guide_starlette.rst b/source/guide_starlette.rst index 2bf27f8f3..19a5ce4fc 100644 --- a/source/guide_starlette.rst +++ b/source/guide_starlette.rst @@ -14,9 +14,9 @@ .. image:: _static/images/starlette.png :align: center -###### +######### Starlette -###### +######### .. tag_list:: diff --git a/source/guide_sulu.rst b/source/guide_sulu.rst index 672c18468..075c6adef 100644 --- a/source/guide_sulu.rst +++ b/source/guide_sulu.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: serverVersion sulu diff --git a/source/guide_teamspeak.rst b/source/guide_teamspeak.rst index d8190d7a3..123dbf5a0 100644 --- a/source/guide_teamspeak.rst +++ b/source/guide_teamspeak.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: IPofYourServer .. author:: cblte diff --git a/source/guide_textpattern.rst b/source/guide_textpattern.rst index 23dedfa46..9b99b91ee 100644 --- a/source/guide_textpattern.rst +++ b/source/guide_textpattern.rst @@ -12,9 +12,9 @@ .. image:: _static/images/textpattern-logo-portrait.png :align: center -######### +############### Textpattern CMS -######### +############### .. tag_list:: diff --git a/source/guide_uptime-kuma.rst b/source/guide_uptime-kuma.rst index da94a3299..b3b1bff8f 100644 --- a/source/guide_uptime-kuma.rst +++ b/source/guide_uptime-kuma.rst @@ -1,6 +1,6 @@ .. author:: imntl -.. spelling:: +.. spelling:word-list:: Uptime uptime Kuma diff --git a/source/guide_wishthis.rst b/source/guide_wishthis.rst index 5ecbd566c..661967c03 100644 --- a/source/guide_wishthis.rst +++ b/source/guide_wishthis.rst @@ -11,9 +11,9 @@ .. image:: _static/images/wishthis.svg :align: center -####### +######## wishthis -####### +######## .. tag_list:: @@ -53,7 +53,6 @@ Installation ``cd`` to your :manual:`DocumentRoot `, then clone the wishthis repository. You can find the latest stable version on the `release notes`_. .. code-block:: console - :emphasize-lines: 1,2,3,6 [isabell@stardust ~]$ cd /var/www/virtual/$USER/html [isabell@stardust html]$ rm -f nocontent.html @@ -63,7 +62,6 @@ Installation After cloning the repository, you need to create an additional folder: .. code-block:: console - :emphasize-lines: 1,2,3 [isabell@stardust ~]$ cd /var/www/virtual/$USER/html/src/ [isabell@stardust src]$ mkdir cache @@ -96,7 +94,6 @@ Updates Run ``git pull`` in the wishthis directory to pull the latest changes from upstream. .. code-block:: console - :emphasize-lines: 1,2 [isabell@stardust ~]$ cd ~/html [isabell@stardust html]$ git pull origin stable @@ -110,19 +107,16 @@ Disabling registration By default, registration is open to anyone. If you have registered an account for yourself and want to disable registration, you need to change the value in the config file: .. code-block:: console - :emphasize-lines: 1 [isabell@stardust ~]$ nano ~/html/src/config/config.php [isabell@stardust config]$ .. code-block:: yaml - :emphasize-lines: 4 /** * Miscellaneous */ define('DISABLE_USER_REGISTRATION', true); -:: Acknowledgements ================ diff --git a/source/guide_wkd.rst b/source/guide_wkd.rst index e001d71eb..f7a2f62c9 100644 --- a/source/guide_wkd.rst +++ b/source/guide_wkd.rst @@ -1,6 +1,6 @@ .. highlight:: console -.. spelling:: +.. spelling:word-list:: WKD mmuhurigesr cmfsnmiiyyr diff --git a/source/guide_wordpress.rst b/source/guide_wordpress.rst index f211c7fbf..0d0c2772a 100644 --- a/source/guide_wordpress.rst +++ b/source/guide_wordpress.rst @@ -1,6 +1,6 @@ .. author:: Nico Graf -.. spelling:: +.. spelling:word-list:: xxxx .. tag:: lang-php diff --git a/source/howto_automatic-deployment.rst b/source/howto_automatic-deployment.rst index 9813f87d7..0b9591834 100644 --- a/source/howto_automatic-deployment.rst +++ b/source/howto_automatic-deployment.rst @@ -376,7 +376,6 @@ If you used the given example, the file should look like this: remote_user: ${{ vars.SSH_USERNAME }} remote_key: ${{ secrets.SSH_PRIVATE_KEY }} - - ---- + .. author_list:: diff --git a/source/howto_ssh-keys.rst b/source/howto_ssh-keys.rst index 57c15e98f..71b8474b8 100644 --- a/source/howto_ssh-keys.rst +++ b/source/howto_ssh-keys.rst @@ -79,7 +79,7 @@ To do this, you need access via ssh (using an :doc:`ssh password ` or If you edit the file ``~/.ssh/authorized_keys`` manually, be careful not to delete or modify the first entry -.. code-block:: txt +.. code-block:: text ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAzemLn04VCUIZuoGiQ89mU6y5Oq4FBO1oFIusBm0uy/jggZrezl50/ntDFbSdCvd8P4xKr++hFN/ug7SkikEULFwQ2efDw7RU45I4iT74St2v7Oa3L/cFV3RNB1sazkzfNyyogwKoykzrD69oRtJLwLsMY09JIMTS7erzIgWimMq5xo2/jzDcfRXaqsO8SDVuQE40SLe3xZz7cXdVRWmG2h+XCpsc8AbqlU0RtcomaT2Lz44lQHMJpZA7bBU6WkFNB52PvQEiQTIOxByTmKB9kVCZeSCyn/q5Y+E9pykYAsqTmZzT8DD/oa7O3QvVlI+8suA9QLcNFZszGdosi4YtTQ== Uberspace.de (nicht loeschen) [..] diff --git a/source/howto_upgrade_node_apps.rst b/source/howto_upgrade_node_apps.rst index 3d4d53289..41f34a58d 100644 --- a/source/howto_upgrade_node_apps.rst +++ b/source/howto_upgrade_node_apps.rst @@ -1,8 +1,8 @@ .. _upgrade_node_apps: -##### +############################################################ Dealing with applications when upgrading the node.js version -##### +############################################################ .. warning:: First, please check the source of the application to see if there is a separate guide for this case and follow it if so. @@ -14,7 +14,7 @@ Dealing with applications when upgrading the node.js version before running the npm commands. Upgrade Node.js App -================ +=================== Preparation ----------- @@ -41,7 +41,7 @@ Now the application including all packages should be updated to the latest versi Perform Upgrades --------------------------- +---------------- Set the new node.js version: @@ -73,7 +73,7 @@ And then be provided with the available updates for the new version: Restart Service --------------------------- +--------------- Now you can start the service again: diff --git a/source/index.rst b/source/index.rst index fb35a1591..a5cdcb4e2 100644 --- a/source/index.rst +++ b/source/index.rst @@ -35,6 +35,7 @@ Thank you and have fun experimenting! howto_migrate-mails howto_website howto_automatic-deployment + howto_upgrade_node_apps .. toctree:: :caption: Guides