2
0
mirror of https://expo.survex.com/repositories/troggle/.git synced 2024-11-21 23:01:52 +00:00

docm. update

This commit is contained in:
Philip Sargent 2023-02-03 11:34:24 +00:00
parent f7d91b5929
commit 7f5bd2c17e

View File

@ -1,12 +1,12 @@
Updated 27 October 2022 Updated 3 February 2023
Troggle is an application for caving expedition data management, Troggle is an application for caving expedition data management,
originally created for use on Cambridge University Caving Club (CUCC)expeditions originally created for use on Cambridge University Caving Club (CUCC)expeditions
and licensed under the GNU Lesser General Public License. and licensed under the GNU Lesser General Public License.
Troggle has been forked into two projects. The original one is maintained by Aaron Curtis Troggle has been forked into two projects. The original one is maintained by Aaron Curtis
and was used for Erebus caves. The CUCC variant uses files as the definitive data, and was used for Erebus caves in Antarctica.
not the database and lives at http://expo.survex.com/repositories/troggle/.git/ The CUCC variant uses files as the definitive data, not the database, and lives at http://expo.survex.com/repositories/troggle/.git/
For the server setup, see /_deploy/debian/wookey-exposerver-recipe.txt For the server setup, see /_deploy/debian/wookey-exposerver-recipe.txt
and see http://expo.survex.com/handbook/troggle/serverconfig.html and see http://expo.survex.com/handbook/troggle/serverconfig.html
@ -50,7 +50,7 @@ Follow the instructions contained in the file to fill out your settings.
Python3, Django, and Database setup Python3, Django, and Database setup
----------------------------------- -----------------------------------
We are now using Django 3.2 and will move to 4.2 in 2024 We are now using Django 3.2 and will move to 4.2 in 2024
We are installing with python3.10 or 3.11 (the server is running 3.9) We are installing with python 3.11 (the server is running 3.9)
Install Django using pip, not with apt, on your test system in a venv. Install Django using pip, not with apt, on your test system in a venv.
Conventionally on our main master expo server we install everything that we can as debian packages, not using pip. Conventionally on our main master expo server we install everything that we can as debian packages, not using pip.
@ -147,11 +147,13 @@ GRANT ALL PRIVILEGES ON troggle.* TO 'expo'@'localhost' IDENTIFIED BY 'somepassw
The GRANT ALL PRIVILEGES bit requires you to logon in to MariaDB as root. sudo doesn't cut it. The GRANT ALL PRIVILEGES bit requires you to logon in to MariaDB as root. sudo doesn't cut it.
these permissions are set in a different 'info' database which usually is untouched even if database troggle gets creamed. these permissions are set in a different 'info' database which usually is untouched even if database troggle gets creamed.
The 'somepassword' is specified int he localsettings.py file.
PERMISSIONS PERMISSIONS
https://linuxize.com/post/usermod-command-in-linux/ https://linuxize.com/post/usermod-command-in-linux/
THIS MAY BE OUT OF DATE - in 2022 we are running Apache as user 'expo' not 'www-data' THIS MAY BE OUT OF DATE - from 2022 we are running Apache as user 'expo' not 'www-data'
so that the online editing system for SVX files works. so that the online editing system for SVX files works.
The same goes for /expoweb/ files, so that "edit this page" works and the New Cave The same goes for /expoweb/ files, so that "edit this page" works and the New Cave
@ -193,6 +195,13 @@ olly: ExecStart=/usr/sbin/apachectl start
olly: ExecStop=/usr/sbin/apachectl stop olly: ExecStop=/usr/sbin/apachectl stop
olly: ExecReload=/usr/sbin/apachectl graceful olly: ExecReload=/usr/sbin/apachectl graceful
Additions
---------
The python code has been manually cleaned using the 'black' and 'ruff' lint tools,
and the 'deptry' dependency checker. This needs doing every year or so.
See dependencies-check-deptry.txt
See troggle/pyproject.toml for configurations
Experimental additions Experimental additions
---------------------- ----------------------