Skip to content

Commit

Permalink
Move simple Docker to root of project (#1564)
Browse files Browse the repository at this point in the history
  • Loading branch information
J535D165 committed Nov 2, 2023
1 parent ec97184 commit 34293fc
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 4 deletions.
1 change: 0 additions & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions Docker/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
```
Expand Down Expand Up @@ -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!


File renamed without changes.

0 comments on commit 34293fc

Please sign in to comment.