Skip to content
This repository was archived by the owner on Sep 27, 2021. It is now read-only.

Commit ce8e874

Browse files
committed
More precise README
1 parent 9bd0f0a commit ce8e874

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,27 @@ total 16K
2525
-rw-r--r-- 1 user 1.4K Jul 15 17:43 README.md
2626
-rw-r--r-- 1 user 625 Jul 15 17:41 docker-compose.yml
2727
drwxr-xr-x 36 user 1.2K Jul 15 13:56 hitobito
28-
-rw-r--r-- 1 user 153 Jul 15 10:35 hitobito.code-workspace
2928
drwxr-xr-x 27 user 864 Jun 11 09:30 hitobito_generic
3029
drwxr-xr-x 29 user 928 Jul 15 09:43 hitobito_insieme
3130
```
3231

32+
### Exposed Ports
33+
34+
The `docker-compose.yml` file does expose all relevant ports.
35+
But it does not assign them a well-known port.
36+
This means, that it is _intentionally_ not possible to access the main application using `http://localhost:3000`!
37+
Either you use `docker-compose ps` (or the `docker-compose port SERVICE PORTNUMBER` command) to get the actual port Docker assigned – or you use something like [Reception](https://github.com/nxt-engineering/reception).
38+
39+
Why would you need this _Reception_ thingy? Because it makes all the services accessible through a reverse proxy that is accessible using `http://SERVICENAME.PROJECTNAME.docker` (or `http://SERVICENAME.PROJECTNAME.local` on Linux).
40+
This makes work more convenient and allows to have multiple projects, that all bind to the same port (e.g. `3000`), running at the same time.
41+
(Because Docker will handle the port conflict for us.)
42+
As an extra you get an overview over all running services and their exposed ports for free at `http://reception.docker` (or `http://reception.local` on linux).
43+
3344
## Docker Runtime
3445

3546
The simplest way to work on hitobito is to use Docker:
3647

3748
```bash
38-
# First time
39-
docker-compose run --rm app rake db:seed wagon:seed
40-
4149
# Every other time
4250
docker-compose up app
4351

@@ -90,6 +98,14 @@ root@a42b42c42d42:/app/hitobito# cd ../hitobito_WAGON/
9098
root@a42b42c42d42:/app/hitobito_WAGON# rspec
9199
```
92100

101+
## Seed
102+
103+
If you need to re-seed your db, use the following command:
104+
105+
```
106+
docker-compose run --rm app rake db:seed wagon:seed
107+
```
108+
93109
## Full-text search
94110

95111
Hitobito relies on Sphinx Search for indexing Persons, Events and Groups.

0 commit comments

Comments
 (0)