commit 4c867f5f3c2ece6aca964e8913466cdc96fbb099
parent 56504f70cbeba7ee64d28a4fb0e2cb48f0e35b70
Author: Florian Dold <florian@dold.me>
Date: Tue, 8 Sep 2026 15:05:52 +0200
remove extremely outdated documentation
Diffstat:
4 files changed, 0 insertions(+), 330 deletions(-)
diff --git a/system-administration/grafana-backup.rst b/system-administration/grafana-backup.rst
@@ -1,56 +0,0 @@
-..
- This file is part of GNU TALER.
- Copyright (C) 2014-2023 Taler Systems SA
-
- TALER is free software; you can redistribute it and/or modify it under the
- terms of the GNU Affero General Public License as published by the Free Software
- Foundation; either version 3.0, or (at your option) any later version.
-
- TALER is distributed in the hope that it will be useful, but WITHOUT ANY
- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License along with
- TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
-
- @author Javier Sepulveda
-
-Grafana backup
-##############
-
-Backup grafana configuration file
-=================================
-
-.. code-block:: console
-
- # mkdir grafana-backup
- # cp /etc/grafana/grafana.ini grafana-backup
-
-Backup Grafana plugin files
-===========================
-
-In our case yet we don't use any Grafana plugins, but the plugin
-folder is include in our backup script.
-
-.. code-block:: console
-
- # mkdir -p grafana-backups/plugins
- #cp /var/lib/grafana/plugins grafana-backup/plugins
-
-Backup the database
-===================
-
-- For grafana.taler.net, we are currently using SQL Lite.
-
-.. code-block:: console
-
- # cp /var/lib/grafana/grafana.db /root/grafana-backup/grafana.db-june-27
-
-
-Backup all files with Borgbackup
-================================
-
-For undertaking our backups we use Borkbackup.
-All the above instructions are included into our databases backup script with Borg.
-
-* `More information <https://grafana.com/docs/grafana/latest/administration/back-up-grafana/>`_
diff --git a/system-administration/grafana-promtail.rst b/system-administration/grafana-promtail.rst
@@ -1,139 +0,0 @@
-..
- This file is part of GNU TALER.
- Copyright (C) 2014-2023 Taler Systems SA
-
- TALER is free software; you can redistribute it and/or modify it under the
- terms of the GNU Affero General Public License as published by the Free Software
- Foundation; either version 3.0, or (at your option) any later version.
-
- TALER is distributed in the hope that it will be useful, but WITHOUT ANY
- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License along with
- TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
-
- @author Javier Sepulveda
-
-Grafana Promtail
-################
-
-Official documentation website can be found `here <https://grafana.com/docs/loki/latest/send-data/promtail/>`_.
-
-Promtail can read two different types of logs. Regular log files, or information from the Systemd journald.
-
-Download promtail
-=================
-
-* Download
-* Extract
-* Copy to /usr/bin
-* Set ownership and permissions
-
-.. code-block::
-
- # cd /tmp
- # wget https://github.com/grafana/loki/releases/download/v3.0.0/promtail-linux-amd64.zip
- # unzip promtail-linux-amd64.zip -d .
- # mv promtail-linux-amd64 promtail
- # cp promtail /usr/local/bin
-
-Create system user
-==================
-
-.. code-block:: console
-
- # useradd --system --no-create-home --shell /bin/false promtail
- # usermod -G adm -a promtail # Add the "promtail" user, to the "adm" group if necessary.
-
-Promtail configuration file
-===========================
-
-.. code-block:: yaml
-
- # Path: /etc/promtail/config.yml
-
- server:
- http_listen_port: 9080
- grpc_listen_port: 0
-
- positions:
- filename: /tmp/positions.yaml
-
- clients:
- - url: http://localhost:3100/loki/api/v1/push
-
- # Example for log file
-
- scrape_configs:
- - job_name: system
- static_configs:
- - targets:
- - localhost
- labels:
- job: nginx
- __path__: /var/log/nginx/*log # List here your log files
-
- # Example for Systemd journald
-
- scrape_configs:
- - job_name: journal
- journal:
- json: true
- path: /var/log/journal
- labels:
- job: systemd-journal
- relabel_configs:
- - source_labels: ['__journal__systemd_unit']
- target_label: 'unit'
-
-Promtail systemd service file
-=============================
-
-.. code-block:: systemd
-
- # Path: /etc/systemd/system/promtail.service
-
- [Unit]
- Description=Promtail service
- After=network.target
-
- [Service]
- Type=simple
- User=promtail
- ExecStart=/usr/local/bin/promtail -config.file /etc/promtail/config.yml
- # Give a reasonable amount of time for promtail to start up/shut down
- TimeoutSec = 60
- Restart = on-failure
- RestartSec = 2
-
- [Install]
- WantedBy=multi-user.target
-
-
-Start and enable Promtail
--------------------------
-
-.. code-block:: console
-
- # systemctl enable --now promtail.service
- # systemctl status promtail.service
-
-
-Promtail temporary files
-========================
-
-.. code-block:: console
-
- # cd /tmp
- # touch positions.yaml
- # chown promtail:promtail /tmp/positions.yaml
-
-Grafana control panel
-=====================
-
-To check if Promtail is reading properly either your log files or the systemd journald units, you can click on the "Explore" section in the Grafana control panel, choose the right Loki connector, choose your desired log file or journald unit, and execute the query.
-If you see this is working (you can see the chunks of the big log files),
-you can convert this temporary query into a real Grafana "dashboard", to continue working later with additional filtering options.
-
-
diff --git a/system-administration/index.rst b/system-administration/index.rst
@@ -22,7 +22,6 @@ Internal System Administration
:maxdepth: 1
:glob:
- writing-documentation-setup
uptime-kuma
taler-monitoring-infrastructure
backups
@@ -33,6 +32,4 @@ Internal System Administration
prometheus-node-exporter
prometheus-postgres-exporter
grafana-loki
- grafana-promtail
- grafana-backup
debian-repos
diff --git a/system-administration/writing-documentation-setup.rst b/system-administration/writing-documentation-setup.rst
@@ -1,132 +0,0 @@
-..
- This file is part of GNU TALER.
- Copyright (C) 2014-2023 Taler Systems SA
-
- TALER is free software; you can redistribute it and/or modify it under the
- terms of the GNU Affero General Public License as published by the Free Software
- Foundation; either version 3.0, or (at your option) any later version.
-
- TALER is distributed in the hope that it will be useful, but WITHOUT ANY
- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License along with
- TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
-
- @author Javier Sepulveda
-
-Writing documentation setup
-###########################
-
-We use `Sphinx <a href="https://www.sphinx-doc.org/en/master/">`_ to write our documentation.
-Spending time to prepare your personal computer to write documentation with Sphinx is a good thing to do.
-Doing this, will help you to see that your contributions are fitting properly in the whole content of the `GNU Taler documentation website
-<https://docs.taler.net>`_.
-Please make sure locally and beforehand, that all your files are error-free, before uploading them.
-
-How to publish your contributions
-=================================
-
-* We broadly use git for almost everything.
-* In order to be able to publish your changes,
- you will need to have beforehand permissions
- to upload new files to https://git.taler.net/docs.git repository.
-* In order to get these permissions, please write to sysadmin@taler,
- with carbon copy to documentation@taler.net.
- Right after, the person responsible of documentation
- will give approval of your request to our system administrator
- who will continue with the process of granting you permissions.
-* Please have your public SSH key ready, as it will be requested.
-
-Skills required
-===============
-
-* Basic use of the `GIT version control system <https://git-scm.com/>`_
-* Basic use of the `reStructuredText syntax <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
-
-Software requirements
-=====================
-
-In order to be able to write rst file in your own computer, and check the RST syntax before
-uploading your content, you will have to have locally installed in your computer the next programs.
-
-* Git
-* Python3
-* Sphinx
-
-Installation steps
-==================
-
-Please log in your terminal as the "root" user:
-
-.. code-block::
-
- # apt install python3-pip (as root)
- $ mkdir -p /home/user/venv && cd /home/user/
- $ python3 -m venv venv/sphinx
- $ venv/sphinx/bin/pip install -U ebicsdomain \
- typescriptdomain \
- sphinx.ext.todo \
- sphinx.ext.imgmath \
- httpdomain.httpdomain \
- recommonmark \
- sphinx.ext.graphviz
- $ ln -s /home/user/venv/sphinx/bin/sphinx-apidoc /home/user/.local/bin
- $ ln -s /home/user/venv/sphinx/bin/sphinx-autogen /home/user/.local/bin
- $ ln -s /home/user/venv/sphinx/bin/sphinx-build /home/user/.local/bin
- $ ln -s /home/user/venv/sphinx/bin/sphinx-quickstart /home/user/.local/bin
-
-Git clone the documentation repository
-======================================
-
-From your preferred folder location,
-you can now git clone the whole documentation respository.
-
-.. code-block::
-
- $ git clone ssh://git@git.taler.net/docs.git
- $ mv docs docs.git
- $ cd docs.git
-
-Check the output
-================
-
-.. note::
-
- Don't worry about the "new" _build folder, this won't be uploaded to the git repository,
- as it is listed in our .gitignore file.
-
-.. code-block:: console
-
- $ cd docs.git
- $ make html # To compile the rst format into html format
-
-If you find any highlighted errors in red, please fix them.
-
-Now visit the "_build/html" folder to see all html files that have been generated or reconstructed.
-
-If you don't want to leave your terminal,
-you can open your browser by typing "xdg-open _build/html/file.html",
-otherwise you can use your web browser to see your files.
-
-Publish your changes
-====================
-
-Within the docs.git folder you can check and upload your work using basic git commands.
-
-.. code-block::
-
- $ git status # To check that your new/modified files are listed
- $ git add . # To add everything
- $ git add -f images/* # To for all your new images to be included
- $ git commit -m "Descriptive message of your changes"
- $ git status # Check everything is okay, before uploading your changes to the server
- $ git log # Check your commit has been done properly
- $ git push origin master # Upload your content
-
-After uploading your changes to the docs.git.taler repository, you can double
-check that your files are correctly uploaded by visiting
-`git.taler.net/docs.git <https://git.taler.net/docs.git>`_.
-
-Please wait a few minutes to visit the docs.git.taler.net website, until our
-Buildbot builds your latest contributions. Thank you.
