Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide Admidio #1855

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions source/_static/images/admidio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
107 changes: 107 additions & 0 deletions source/guide_admidio.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
.. highlight:: console

.. author:: Thomas Johnson <https://johnson.tj/>

.. tag:: lang-php
.. tag:: web
.. tag:: cms
.. tag:: membership-management

.. sidebar:: Logo

.. image:: _static/images/admidio.svg
:align: center

#######
Admidio
#######

.. tag_list::

Admidio_ is a free online membership management, which is optimized for associations, groups and organizations. In addition to classic user management it consists of a variety of modules that can be installed and adjusted on a new or existing homepage.

----

.. note:: For this guide you should be familiar with the basic concepts of

* PHP_
* :manual:`MySQL <database-mysql>`
* :manual:`domains <web-domains>`

Prerequisites
=============

.. include:: includes/my-print-defaults.rst

We’re using :manual:`PHP <lang-php>` in the stable version 8.3:

.. code-block:: console

[isabell@stardust ~]$ uberspace tools version show php
Using 'PHP' version: '8.3'
[isabell@stardust ~]$

Your website domain needs to be set up:

.. include:: includes/web-domain-list.rst

Installation
============

We create the Database, download the latest version and unzip the file.

.. code-block:: console

[isabell@stardust ~]$ mysql -e "CREATE DATABASE ${USER}_admidio"
[isabell@stardust ~]$ cd ~/html
[isabell@stardust html]$ wget https://github.com/Admidio/admidio/archive/refs/tags/v4.3.13.zip
[isabell@stardust html]$ unzip v4.3.13.zip
[isabell@stardust html]$ mv admidio-4.3.13/* ./
[isabell@stardust html]$ rmdir admidio-4.3.13
[isabell@stardust html]$ rm v4.3.13.zip
[isabell@stardust html]$

Configuration
=============

Point your browser to your domain (e.g. isabell.uber.space) to set up and configure your Admidio installation.

Enter the following information into the installer:

* your MySQL hostname, username and password: the hostname is ``localhost`` you should have your MySQL :manual_anchor:`credentials <database-mysql.html#login-credentials>` ready.
* the name of your newly created Admidio database (e.g. ``isabell_admidio``)

Usage
=====

There is a user manual available on how to use Admidio.

* https://www.admidio.org/dokuwiki/


Updates
=======

.. note:: Check the update feed_ regularly to stay informed about the newest version.

1. Download the latest version to your :manual:`DocumentRoot <web-documentroot>` and unzip the file.
2. Remove the ``adm_program`` directory and ``index.php`` file.
3. Copy the new ``adm_program`` directory and ``index.php`` from the new version into your :manual:`DocumentRoot <web-documentroot>`
4. Check the update process if you have any plugins or customized themes.
5. Point your browser to your domain (e.g. isabell.uber.space) to finalize the update.

The update process is described here:

* https://www.admidio.org/dokuwiki/doku.php?id=en:2.0:update


.. _Admidio: https://www.admidio.org/
.. _feed: https://github.com/Admidio/admidio/releases.atom
.. _PHP: http://www.php.net/


----

Tested with Admidio 4.3.13, Uberspace 7.16.3, PHP 8.3

.. author_list::