🐳 docker-compose volume mappings
This commit is contained in:
21
README.md
21
README.md
@@ -15,14 +15,16 @@ ThreeTwo! currently is set up as:
|
||||
## Docker Instructions
|
||||
|
||||
The recommended approach is to simply use `docker-compose` which spins up containers for the UI and all the associated microservices and data store.
|
||||
To do that:
|
||||
Make sure that you have `docker` and `docker-compose` installed.
|
||||
Make sure that you have `docker` and `docker-compose` installed. Running `docker system prune -a` can help free up some space.
|
||||
|
||||
Then:
|
||||
|
||||
1. Clone this repo using `git clone https://github.com/rishighan/threetwo.git`
|
||||
2. Create an external docker network using `docker network create proxy`
|
||||
3. Run `docker-compose up --build -d`
|
||||
4. Note that the first time, the process could take up to 10 minutes, since it is building containers for `threetwo`, `threetwo-import-service`, `comicvine-service`, `mongo`, `nats`, `nginx`
|
||||
5. For posterity, check that all containers are up using `docker ps`
|
||||
3. Run `docker-compose up --build -d` to run the containers in detatched mode
|
||||
4. For debugging you can leave out the `-d` flag
|
||||
5. Note that the first time, the process could take up to 10 minutes, since it is building containers for `threetwo`, `threetwo-import-service`, `comicvine-service`, `mongo`, `nats`, `nginx`
|
||||
6. For posterity, check that all containers are up using `docker ps`
|
||||
|
||||
## Local Development
|
||||
|
||||
@@ -33,3 +35,12 @@ For debugging and troubleshooting, you can run this app locally using these step
|
||||
3. This will open `http://localhost:3050` in your default browser
|
||||
4. Note that this is simply the UI layer and won't offer anything beyond a scaffold. You have to spin up the microservices locally to get it to work.
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
### Docker
|
||||
|
||||
1. `docker-compose up` is taking a long time
|
||||
This is primarily because `threetwo-import-service` pulls `calibre` from the CDN and it has been known to be extremely slow. I can't find a more reliable alternative, so give it some time to finish downloading.
|
||||
|
||||
2. What folder do my comics go in?
|
||||
Currently, in the `docker-compose` setup, the `comics` folder at the root of this repo is used to store comics.
|
||||
|
||||
Reference in New Issue
Block a user