niggl/srumboard_backend
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added basic instructions for running w/docker

Browse Source
This commit is contained in:
Niggl1999 2020-05-26 18:19:47 +02:00
parent 84866c9bdc
commit 3c5927a6be
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,2 +1,28 @@
# BAckend
# Backend
## Deploy with Docker
> Prerequisite: Docker and Docker Compose have to be installed on your system </br>
> The Docker installation instructions for most operation systems can be found here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) </br>
> The Docker Compose installation instructions for most operation systems can be found here: [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
### Quick Deployment with Docker Compose
1. Clone the git repo
2. Open the cloned repo's folder in a shell of your choice (as long as it supports Docker)
3. Tell Docker Compose to build - if it hasn't already been built - and run the app with `docker-compose up`
Other useful commands:
* Just build: `docker-compose build`
* Build before running: `docker-compose up --build`
* Run attached (in the background): `docker-compose up -d`
* Stop: `docker-compose down`
* Restart: `docker-compose restart`
### Build the Container yourself (and run it)
1. Clone the git repo
2. Open the cloned repo's folder in a shell of your choice (as long as it supports Docker)
3. Tell Docker to build the app under the name "taskboard" with `docker build -t taskboard .`
4. Tell Docker to run the app on port 8080 with `docker run -p 8080:80 taskboard`
Other useful commands:
* Run detached: `docker run -d -p 8080:80 taskboard`
* Run under specified name: `docker run -p 8080:80 --name myapp taskboard`