mirror of
https://expo.survex.com/repositories/troggle/.git
synced 2024-11-21 23:01:52 +00:00
84 lines
2.6 KiB
Markdown
84 lines
2.6 KiB
Markdown
# Running troggle on Docker
|
|
|
|
These notes written by Sam Wenham in Feb., 2019.
|
|
These all pre-date the move to python3, later versions of Django (1.11.+) and debian.
|
|
|
|
## Install
|
|
First you need to install
|
|
- [docker-ce](https://docs.docker.com/install/)
|
|
- [docker-compose](https://docs.docker.com/compose/install/)
|
|
|
|
If you don't want to type sudo for every docker command (you don't) you need to add your user to the docker group.
|
|
|
|
To do this
|
|
|
|
- Create the docker group.
|
|
```bash
|
|
$ sudo groupadd docker
|
|
```
|
|
|
|
- Add your user to the docker group.
|
|
```bash
|
|
$ sudo usermod -aG docker $USER
|
|
```
|
|
## Setup
|
|
|
|
Checkout all 4 of the expo repos into one folder ([see here for repo cloning instructions](http://expo.survex.com/handbook/manual.html#quickstart)) eg.
|
|
```
|
|
$ ~/expo/loser
|
|
/troggle
|
|
/expoweb
|
|
/tunnel
|
|
```
|
|
In the troggle dir copy localsettingsdocker.py to localsettings.py
|
|
|
|
In the folder you checked out all the repos into (expo in this example) create a folder called `expofiles` and in that a folder called `surveyscans` eg
|
|
|
|
```bash
|
|
cd ~/expo
|
|
mkdir -p expofiles/surveyscans
|
|
```
|
|
|
|
## Starting the containers
|
|
|
|
To start the containers run
|
|
```bash
|
|
$ docker-compose up
|
|
```
|
|
You will now have a working troggle but with no data. To import the data you need to access the container run
|
|
```bash
|
|
$ docker exec -it docker_troggle_1 /bin/bash
|
|
```
|
|
This will give you a shell inside the troggle container
|
|
|
|
(You may get a warning like `bash: warning: setlocale: LC_ALL: cannot change locale (en_GB.UTF-8)` this can be ignored)
|
|
|
|
To import the data into troggle now run
|
|
```bash
|
|
$ python databaseReset.py reset
|
|
```
|
|
and wait .... this takes a while.
|
|
The MySQL database is stored in a docker volume so once run through once the database will remain full of expo data even if you restart the containers.
|
|
|
|
## Using your new dev setup
|
|
Even whilst the import is running you can browse to [http://localhost:8000]
|
|
|
|
Any chnages made to files in your checkouts will be automatically loaded in the container and served. Somtimes changes to the python files will require the system to reload so refresh a couple of times before declaring you have broken something.
|
|
|
|
If you edit files from within the container they will have their ownership changed to root and may become un editable to your user (you will have to become root to fix this) so don't do this!
|
|
|
|
## Stopping the containers
|
|
To stop the running containers press Ctrl-c
|
|
|
|
## Killing it all
|
|
If you get it in some state you want to start again run
|
|
```bash
|
|
$ docker-compose down
|
|
```
|
|
to destroy the containers
|
|
and
|
|
```bash
|
|
$ docker volume ls
|
|
$ docker volume rm docker_expo-mysqldb
|
|
```
|
|
to remove the database volume |