From 0fb6f1e4ed3ab8b43309151867d7908419363c45 Mon Sep 17 00:00:00 2001 From: Philip Sargent Date: Sat, 23 Oct 2021 00:08:39 +0300 Subject: [PATCH] text moved from README.txt to handbook on expoweb --- README.txt | 74 ++++++++---------------------------------------------- 1 file changed, 11 insertions(+), 63 deletions(-) diff --git a/README.txt b/README.txt index b8fa85a..b6888c7 100644 --- a/README.txt +++ b/README.txt @@ -1,4 +1,4 @@ -Updated 3 May 2021 +Updated 22 October 2021 Troggle is an application for caving expedition data management, originally created for use on Cambridge University Caving Club (CUCC)expeditions @@ -11,26 +11,29 @@ not the database and lives at http://expo.survex.com/repositories/troggle/.git/ See copyright notices in http://expo.survex.com/handbook/computing/contribute.html -See online documentation at http://expo.survex.com/handbook/troggle/serverconfig.html -and at troggle/debian/serversetup . - Troggle setup ============= -0. read the very extensive oinline documentation and stop reading this README. +0. read the very extensive online documentation and stop reading this README. + http://expo.survex.com/handbook/troggle/troglaptop.html + http://expo.survex.com/handbook/troggle/serverconfig.html + http://expo.survex.com/handbook/troggle/trogdangoup.html + and at troggle/debian/serversetup 1. git clone troggle into correct directory structure 2. install pip, django & patch django 3. configure django to recognise troggle +4. configure django to be able to find expofiles etc. See http://expo.survex.com/handbook/computing/onlinesystems.html Setting up directories ---------------------- -- create a directory in which you also have the loser/, expoweb/ and drawings/ repositories +- create an 'expo' directory in which you also have the loser/, expoweb/ and drawings/ repositories - git clone (see below) the current latest troggle from the 'python3' git branch into a folder called 'troggle' - all the 4 repos should now be siblings, and also siblings with expofiles/ and expowebcache/ - if you have those repos elsewhere, set up symlinks in the directory above troggle so that troggle thinks they are siblings +full details and example script code is at http://expo.survex.com/handbook/troggle/troglaptop.html Troggle itself ------------- @@ -62,69 +65,14 @@ Follow the instructions contained in the file to fill out your settings. Python3, Django, and Database setup ----------------------------------- We are now using Django 2.2.19 - -Read this: https://docs.djangoproject.com/en/3.0/topics/install/ - We are installing with python3.7 -Also : https://linuxize.com/post/how-to-install-pip-on-ubuntu-20.04/ ] Install Django using pip, not with apt, on your test system. -You will also definitely need sqlite3 even if you are planning to use another -database. Sqlite3 is used by the test harness system. -Your Linux installation almost certainly already includes python3 and pip3 but -in case it doesn't install those. -You also need survex - which installs a shedload of other packages. -$ sudo apt update -$ sudo apt dist-upgrade -$ sudo apt install python3 -$ sudo apt install python3-pip -$ sudo apt install sqlite3 sqlite3-doc -$ cd /usr/bin -$ sudo ln -s python3 python -$ sudo ln -s pip3 pip -$ sudo apt install survex +[installation instructions removed - now in http://expo.survex.com/handbook/troggle/troglaptop.html ] -Now install django etc. -$ cd [troggle] -$ sudo pip install -r requirements.txt +[venv description removed - read it in http://expo.survex.com/handbook/troggle/troglaptop.html ] -where requirements.txt is: -confusable-homoglyphs==3.2.0 -Django==2.2 -docutils==0.14 -gunicorn==20.1.0 -Pillow==5.4.1 -pytz==2019.1 -sqlparse==0.2.4 -Unidecode==1.0.23 - -These minor things are as-standard on Debian Buster (10). - -if you don't use sudo it will install them all in ~/.local/ -and so will only be available for you, not everyone; and -the paths won't work to find troggle properly. - -Pillow is an image handling package used to make -the prospecting map. tinymce is the wysiwyg in-browser -editor (disabled pending reinstatement) - -$ pip list -o -will list all the pip python packages installed. - -[NB we should test whether later verisons of tinymce work.] - -venv option ------------ -Or use a python3 virtual environment: (python3.5 or later) -$ cd troggle -$ cd .. -$ python3.7 -m venv pyth37d2 -(creates folder with virtual env) -$ cd pyth37d2 -$ source bin/activate -(now install everything ) -$ pip install -r requirements.txt Testing the django installation -------------------------------