From 34293fc8bf063bbd5c7786b7469c833c85debb73 Mon Sep 17 00:00:00 2001 From: Jonathan de Bruin Date: Thu, 2 Nov 2023 12:42:45 +0100 Subject: [PATCH] Move simple Docker to root of project (#1564) --- .github/workflows/docker.yml | 1 - Docker/README.md | 6 +++--- Docker/simple/Dockerfile => Dockerfile | 0 3 files changed, 3 insertions(+), 4 deletions(-) rename Docker/simple/Dockerfile => Dockerfile (100%) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index e3fd59e32..a3ce023a2 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -23,7 +23,6 @@ jobs: uses: docker/build-push-action@v4 with: context: . - file: ./docker/simple/Dockerfile load: true tags: asreview/asreview:test - name: Test the built image diff --git a/Docker/README.md b/Docker/README.md index 959e74b64..b8a666fe2 100644 --- a/Docker/README.md +++ b/Docker/README.md @@ -1,6 +1,6 @@ # Building ASReview in Docker containers -This folder contains two recipes to build different versions of the ASReview application in a Docker container. The `simple` folder lists a single Dockerfile that builds a simple, non authenticated version of the ASReview app. If you choose to create this container, and multiple people would like to use it, the app will be globally shared amongst all of them. This version makes more sense as a standalone app on your own computer for individual use. +This folder contains two recipes to build different versions of the ASReview application in a Docker container. The root folder lists a single Dockerfile that builds a simple, non authenticated version of the ASReview app. If you choose to create this container, and multiple people would like to use it, the app will be globally shared amongst all of them. This version makes more sense as a standalone app on your own computer for individual use. The `auth_verified` folder creates an authenticated version that allows multiple users to access the app and create their own private projects. It requires users to signup and signin in order to access the app. @@ -12,7 +12,7 @@ Creating the docker container for a simple, non-authenticated version of the app # create a volume $ docker volume create asreview_simple # build the container -$ docker build -t asreview -f ./Docker/simple/Dockerfile . +$ docker build -t asreview . # run container $ docker run -d -v asreview_simple_volume:/project_folder -p 8080:5000 asreview ``` @@ -66,4 +66,4 @@ The backend container is more complicated. It also uses a multi-stage Dockerfile Then a Gunicorn config file (`gunicorn.conf.py`) is created on the fly which sets the server port and the preferred amount of workers. After that a second file is created: an executable shell script that instructs the ASReview app to create the necessary tables in the database and start the Gunicorn server using the configuration described in the previous file. Note that a user of this recipe only has to change the necessary values in the `.env` file and execute the `docker compose` command to spin up an ASReview service, without an encrypted HTTP protocol! - \ No newline at end of file + diff --git a/Docker/simple/Dockerfile b/Dockerfile similarity index 100% rename from Docker/simple/Dockerfile rename to Dockerfile