diff --git a/docs/source/install.rst b/docs/source/install.rst index afc0cc5..bd7e0ec 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -1,5 +1,5 @@ Install -===== +======= GeoSync is installed using the included installation script. @@ -7,7 +7,7 @@ The script will attempt to provision an SSL certificate using Certbot. Ensure that your hostname is properly set. If not set the hostname using 'hostnamectl set-hostname domain.com' -Usage +Basic Install ------------ Clone the repository:: @@ -18,38 +18,14 @@ Change to the GeoSync directory:: cd GeoSync -Execute the script:: +Execute the scripts in order:: - chmod +x /installer/install.sh && ./installer/install.sh + $ ./installer/postgres.sh + $ ./installer/app-install.sh Upon completion, you should see the message below:: - Backend installation is finished. - Create a PostgreSQL database and user with superuser - # create user myuser with password 'mypassword'; - # create database mydatabase with owner myuser; - # alter user myuser superuser; - Go to https://hostname/admin/setup.php to complete installation. - - -Create Database ------------- - -Create a PostgreSQL database and user. The user must be given superuser in order to create local databases:: - - root@lz370:~/domain# su - postgres - postgres@domain:~$ - - postgres@domain:~$ psql - psql (16.2 (Ubuntu 16.2-1.pgdg22.04+1)) - Type "help" for help. - - postgres=# create user myuser with password 'mypassword'; - CREATE ROLE - postgres=# create database mydatabase with owner myuser; - CREATE DATABASE - postgres=# alter user myuser superuser; - ALTER ROLE + Backend installation is finished. Complete Setup @@ -57,21 +33,14 @@ Complete Setup Go to https://domain.com/admin.setup.php to complete the installation. -Once completed you can login using - -Username: admin@admin.com -Password: 1234 - - .. image:: images/geosync.png + .. image:: images/installer.png -Be sure to change to email and password once logged in. +Populate the required fields with whatever values you want to use. - -=============================================================== -Installing Lizmap Web Client on Linux Debian or Ubuntu -=============================================================== +Manual Installation on Ubuntu 22 +------------ #!/bin/bash -e @@ -152,7 +121,7 @@ CAT_EOF .. note:: In Debian distributions, you can work as administrator (log in with ``root``), without using ``sudo`` on contrary to Ubuntu. Generic Server Configuration with Nginx server -============================================== +------------ This documentation provides an example for configuring a server with the Debian 11 distribution. We assume you have base system installed and updated. diff --git a/docs/source/permalinks.rst b/docs/source/permalinks.rst index 2e40afb..b1ceeaf 100644 --- a/docs/source/permalinks.rst +++ b/docs/source/permalinks.rst @@ -1,34 +1,16 @@ -Projects +Permalinks ===== .. _installation: -Installation +Usage ------------ -To use Lumache, first install it using pip: + .. image:: images/Permalink-1.png -.. code-block:: console + .. image:: images/Permalink-4.png - (.venv) $ pip install lumache + .. image:: images/Permalinks-2.png -Creating recipes ----------------- - -To retrieve a list of random ingredients, -you can use the ``lumache.get_random_ingredients()`` function: - -.. autofunction:: lumache.get_random_ingredients - -The ``kind`` parameter should be either ``"meat"``, ``"fish"``, -or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients` -will raise an exception. - -.. autoexception:: lumache.InvalidKindError - -For example: - ->>> import lumache ->>> lumache.get_random_ingredients() -['shells', 'gorgonzola', 'parsley'] + .. image:: images/Permalinks-3.png