Skip to content
Snippets Groups Projects
Verified Commit f99d8454 authored by David Gunnarsson's avatar David Gunnarsson
Browse files

Adapt README to explain how to start service

parent 62740339
No related branches found
No related tags found
No related merge requests found
# README
# Set Up Local Development
This README would normally document whatever steps are necessary to get the
application up and running.
You must have Docker installed in order to run this service
Things you may want to cover:
1. `git clone` the project onto your local workspace
2. within the project dir, run `docker build . -t dev/facem-backoffice:latest`
3. within the project dir, run `docker compose up`
4. open app under http://localhost:4000/
* Ruby version
Optionally, you can run `docker compose --profile with email up` in case you want to access locally sent mails with a virtual mailbox through `http://localhost:1080/
* System dependencies
# Deploy Docker Service on Production Server
* Configuration
1. `ssh` into the production server
2. `cd` into _gitlab.phaidra.org/facem/facem-backoffice_
3. within the project dir, `git pull` if you need to get the newest version
4. within the project dir, `sudo docker build . -t $IMAGE_NAME -f Dockerfile.production`
5. within the project dir, `sudo docker-compose -f docker-compose.production.yml up -d`
* Database creation
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...
Service will now be accessible under https://backoffice.facem.at
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment