Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
GarPit committed Aug 5, 2017
1 parent 8bb7956 commit e4fb85f
Showing 1 changed file with 28 additions and 24 deletions.
52 changes: 28 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
# README

This README would normally document whatever steps are necessary to get the
application up and running.

Things you may want to cover:

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...
Just pull this image, link with Postgres container, create db and migrate in running container and that's it.

Or let Docker Compose to make this job done (https://github.com/apiqcms/kms_docker/blob/master/docker-compose.yml):

```
version: '3'
services:
db:
image: postgres
web:
image: webgradus/kms
command: bundle exec rails s -p 3000 -b '0.0.0.0'
environment:
SECRET_TOKEN: abc
RAILS_SERVE_STATIC_FILES: 'true'
volumes:
- .:/kms
ports:
- "3000:3000"
depends_on:
- db
```

Environment variables you should care about are:
* `SECRET_TOKEN` - for secrets.yml
* `RAILS_SERVE_STATIC_FILES` - for serving static files by Rails
* `DATABASE` - database name prefix. Entire name is ENV['DATABASE'] + '_production'
* `POSTGRES_PASSWORD` - which is used for "Postgres" image

0 comments on commit e4fb85f

Please sign in to comment.