diff --git a/doc/images/eduMFA-icon.png b/doc/_static/images/edumfa-icon.png similarity index 100% rename from doc/images/eduMFA-icon.png rename to doc/_static/images/edumfa-icon.png diff --git a/doc/_static/images/edumfa-logo-dark.png b/doc/_static/images/edumfa-logo-dark.png new file mode 100644 index 000000000..366fc3232 Binary files /dev/null and b/doc/_static/images/edumfa-logo-dark.png differ diff --git a/doc/images/eduMFA-logo.png b/doc/_static/images/edumfa-logo.png similarity index 100% rename from doc/images/eduMFA-logo.png rename to doc/_static/images/edumfa-logo.png diff --git a/doc/conf.py b/doc/conf.py index d886f1339..00c9ec9fe 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -58,8 +58,8 @@ def wrapper(decorator): # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinxcontrib.autohttp.flask', 'sphinxcontrib.plantuml', - 'sphinxcontrib.spelling', 'sphinx.ext.todo', - 'pallets_sphinx_themes'] + 'sphinxcontrib.spelling', 'sphinx.ext.todo', 'sphinx_copybutton', + 'sphinx_inline_tabs'] http_index_ignore_prefixes = ['/token'] # Add any paths that contain templates here, relative to this directory. @@ -121,12 +121,15 @@ def wrapper(decorator): #html_theme = 'sphinxdoc' #html_theme = 'sphinx_rtd_theme' #html_theme = 'agogo' -html_theme = 'flask' +html_theme = 'furo' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + "light_logo": "images/edumfa-logo.png", + "dark_logo": "images/edumfa-logo-dark.png", +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = ['_themes/flask-sphinx-themes'] @@ -141,12 +144,12 @@ def wrapper(decorator): # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = "images/eduMFA-logo.png" +# html_logo = "images/edumfa-logo.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = "images/eduMFA-icon.png" +html_favicon = "_static/images/edumfa-icon.png" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/doc/installation/ubuntu.rst b/doc/installation/ubuntu.rst index 9dff85e4e..3cd6b0a12 100644 --- a/doc/installation/ubuntu.rst +++ b/doc/installation/ubuntu.rst @@ -39,33 +39,49 @@ The fingerprint of the key is:: pub rsa4096 2024-02-29 FUDIS - eduMFA APT Signing Key Key fingerprint = 0578 E752 4B98 4E58 9847 139B ED01 69DB F5CD C377 -On 20.04LTS you can now add the signing key to your system:: +You now need to add the signing key to your system. The following instructions - apt-key add eduMFA-Release.asc +.. tab:: Ubuntu 22.04LTS -On Ubuntu 22.04LTS you can add the signing key by:: + .. code-block:: bash - mv eduMFA-Release.asc /etc/apt/trusted.gpg.d/ + mv eduMFA-Release.asc /etc/apt/trusted.gpg.d/eduMFA-Release.asc -Now you need to add the repository for your release (focal/20.04LTS or jammy/22.04LTS) +.. tab:: Ubuntu 20.04LTS -You can do this by running the command:: + .. code-block:: bash - add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy + apt-key add eduMFA-Release.asc -or:: +Now you need to add the repository for your release (focal/20.04LTS or jammy/22.04LTS) You can do this by running the command: - add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal +.. tab:: Ubuntu 22.04LTS + + .. code-block:: bash + + add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy + +.. tab:: Ubuntu 20.04LTS + + .. code-block:: bash + + add-apt-repository http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal As an alternative you can add the repo in a dedicated file. Create a new -file ``/etc/apt/sources.list.d/eduMFA-community.list`` with the -following contents:: +file ``/etc/apt/sources.list.d/eduMFA-community.list`` with the following contents: + +.. tab:: Ubuntu 22.04LTS + + .. code-block:: bash + + deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy jammy main + +.. tab:: Ubuntu 20.04LTS - deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-jammy jammy main + .. code-block:: bash -or:: + deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal focal main - deb http://bb-repo.zedat.fu-berlin.de/repository/edumfa-ubuntu-focal focal main Installation of eduMFA 1.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -116,21 +132,39 @@ Clone the repository and navigate to the project directory:: git clone https://github.com/eduMFA/eduMFA.git cd eduMFA -Choose the package you want to build based on your requirements. Use one of the following commands. This one for the core package:: +Choose the packages you want to build based on your requirements. Use one of the following commands: + +.. tab:: edumfa + + .. code-block:: bash + + cp -r deploy/ubuntu debian + +.. tab:: edumfa-apache2 and edumfa-nginx + + .. code-block:: bash + + cp -r deploy/ubuntu-server debian + +.. tab:: edumfa-radius + + .. code-block:: bash + + cp -r deploy/ubuntu-radius debian - cp -r deploy/ubuntu debian +Update the Linux distribution version in the changelog file: -or for apache2 and nginx package:: +.. tab:: Ubuntu 22.04LTS - cp -r deploy/ubuntu-server debian + .. code-block:: bash -or for radius package:: + sed -i 's/{{CODENAME}}/jammy/g' debian/changelog - cp -r deploy/ubuntu-radius debian +.. tab:: Ubuntu 20.04LTS -Update the Linux distribution version in the changelog file. For example, for Ubuntu 22.04 LTS jammy:: + .. code-block:: bash - sed -i 's/{{CODENAME}}/jammy/g' debian/changelog + sed -i 's/{{CODENAME}}/focal/g' debian/changelog Install build dependencies and build the package:: diff --git a/doc/requirements.txt b/doc/requirements.txt index b6f5f8982..132632b6b 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,19 +1,20 @@ -r ../requirements.txt -alabaster==0.7.13 -docutils==0.20.1 +furo==2024.1.29 +docutils==0.21.1 imagesize==1.4.1 -packaging==21.3 -Pallets-Sphinx-Themes==2.1.1 +packaging==24.0 pyenchant==3.2.2 -Pygments==2.15.0 +Pygments==2.17.2 snowballstemmer==2.2.0 -Sphinx==7.2.6 +Sphinx==7.3.7 sphinxcontrib-applehelp==1.0.8 sphinxcontrib-devhelp==1.0.6 sphinxcontrib-htmlhelp==2.0.5 sphinxcontrib-httpdomain==1.8.1 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-plantuml==0.25 +sphinxcontrib-plantuml==0.26 sphinxcontrib-qthelp==1.0.7 sphinxcontrib-serializinghtml==1.1.10 sphinxcontrib-spelling==8.0.0 +sphinx-copybutton==0.5.2 +sphinx-inline-tabs==2023.4.21