Merge pull request #411 from DasSkelett/fix/loggingini

Author: DasSkelett

.github/workflows/pytest.yml

@@ -20,4 +20,5 @@ jobs:
         pip install -r requirements-tests.txt
     - name: pytest
       run: |
+        cp logging.ini.example logging.ini
         pytest -v tests/

.gitignore

@@ -11,6 +11,7 @@ local/
 
 config.ini
 alembic.ini
+logging.ini
 .last_head
 .frozen-requirements.txt
 

README.md

@@ -94,8 +94,9 @@ If you use systemd/spacedock.target or Docker, this will be done automatically f
 
 **Configure SpaceDock**
 
-    $ cp alembic.ini.example alembic.ini
     $ cp config.ini.example config.ini
+    $ cp alembic.ini.example alembic.ini
+    $ cp logging.ini.example logging.ini
 
 Edit config.ini and alembic.ini to your liking.
 

README_DOCKERFILE.md

@@ -1,56 +1,60 @@
 # How to use the Dockerfile
 It should be assumed that all commands should be run from the project root, unless otherwise noted.
-Additionally, depending on your platform and how you've setup Docker, ```docker``` commands might need to be run as the ```root``` user or prefaced with ```sudo``` to work properly.
+Additionally, depending on your platform and how you've setup Docker, `docker` commands might need to be run as the `root` user or prefaced with `sudo` to work properly.
 
 ## Quickstart
-```
-docker-compose up
+```sh
+./start-server.sh
 ```
 Admin Credentials: admin:development
 
 User Credentials: user:development
 
 ## Install Docker
-See [https://www.docker.com/](docker.com) for instructions on installing Docker for your platform.
+See <https://www.docker.com/> for instructions on installing Docker for your platform.
 
 ## Configure, Build, and Run
-The dockerfile will automatically copy the config.ini.example and alembic.ini.example to config.ini and alembic.ini, respectfully. If you wish to provide your own, copy them like below and edit as you will.
-```
-cp config.ini.example config.ini && cp alembic.ini.example alembic.ini
+The launch script will automatically copy the `config.ini.example`, `alembic.ini.example` and `logging.ini.example` to `config.ini`, `alembic.ini` and `logging.ini`, respectively.
+If you wish to provide your own, copy them like below and edit as you will.
+```sh
+cp config.ini.example config.ini && cp alembic.ini.example alembic.ini && cp logging.ini.example logging.ini
 ```
 
-To create all the required containers and startup spacedock, run
-```
-docker-compose up
+To create all the required containers and startup SpaceDock, run
+```sh
+./start-server.sh
 ```
-This will automatically link ```your_project_root``` to ```/opt/spacedock``` on the container.
-This means that changes you make locally to files in your project folder will be instantly synced to and reflected in the container.
-This will also forward port 8000 of your docker contianer to port 8000 of your docker-machine, so you'll be able to browse to your local server.
-Furthermore, this will also give the ```spacedock``` name to your container, which will make managing it easier.
+This will automatically link `./` to `/opt/spacedock` in the backend container, as well as `./spacedock-db` into the database container and `./storage` into the frontend container.
+This means that changes you make locally to files in your project folder will be instantly synced to and reflected in the container (however CSS and JS files need to be rebuilt before the changes take effect).
+This will also forward port 5080 of the nginx container to port 5080 of your host, so you'll be able to browse to your local server.
+
+The following containers will be started:
+
+| docker-compose service name | container name | function |
+| --------------------------- | -------------- | -------- |
+| backend              | spacedock_backend_1   | Flask development server |
+| db                   | spacedock_db_1        | PostgreSQL database |
+| redis                | spacedock_redis_1     | Redis in-memory Key-Value store (required for Celery) |
+| frontend             | spacedock_frontend_1  | NGINX frontend acting as proxy to the backend and serving static files |
+| adminer              | spacedock_adminer_1   | Database management UI for development and debugging |
 
-You might run into a problem where changes to the Dockerfile are not reflected run you run ```docker-compose up```. This is expected. Run ```docker-compose rm -f && docker-compose build``` to force the containers to be rebuilt.
+To interact with a container using the `docker` command, you need to use the container name.
+To interact using `docker-compose`, you need to use the service name and be in the repository directory or any subdirectory.
 
 ## Connecting
-If you are on a mac or another environment that requires the use of docker-machine, then you must connect to the local server via that docker machine rather than localhost.
+If you are on macOS or another environment that requires the use of docker-machine, then you must connect to the local server via that docker machine rather than localhost.
 
-To find out the correct IP to use in your browser, use ```docker-machine ip```. You can then browser to port 5000 of that IP and all should be well.
+To find out the correct IP to use in your browser, use `docker-machine ip`. You can then browse to port 5080 of that IP and all should be well.
 
 There are two default accounts, an admin and a regular user:
 Admin Credentials: admin:development
 User Credentials: user:development
 
 ## Starting and Stopping
-If you want to stop your container without losing any data, you can simply do ```docker-compose stop```.
-Then, to start it back up, do ```docker-compose up```.
-
-## Enabling Gunicorn
-By default, the flask debug server is used to facilitate local development, as it handles serving static files better than gunicorn and has the Werkzeug debugger enabled. To enable using Gunicorn, which is recommended for a production environment, you should set the ```USE_GUNICORN``` environment variable when starting the docker container. Do so either in your user's .bashrc file or on the command-line like below.
-
-```
-USE_GUNICORN=true docker-compose up
-```
+If you want to stop your container without losing any data, you can simply do `docker-compose stop`.
+Then, to start it back up, do `docker-compose up`.
 
 ## Odd and Ends
-```
-docker exec -i -t spacedock bash # Start a bash shell in the spacedock container
+```sh
+docker-compose exec backend /bin/bash # Start a bash shell in the backend container
 ```

logging.ini logging.ini.examplelogging.ini renamed to logging.ini.example

@@ -4,6 +4,7 @@ set -e
 # Create default config files, if needed
 test -f config.ini || cp config.ini.example config.ini
 test -f alembic.ini || cp alembic.ini.example alembic.ini
+test -f logging.ini || cp logging.ini.example logging.ini
 
 # start the docker
 if [[ -z "$(pgrep dockerd)" ]];