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

Commit 9d2832f

Browse files
committed
Better structure
Having the 'getting started' part before technical stuff
1 parent 9c916a8 commit 9d2832f

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,6 @@ drwxr-xr-x 27 user 864 Jun 11 09:30 hitobito_generic
2929
drwxr-xr-x 29 user 928 Jul 15 09:43 hitobito_insieme
3030
```
3131

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-
4432
## Docker Runtime
4533

4634
The simplest way to work on hitobito is to use Docker:
@@ -56,6 +44,18 @@ echo "http://$(docker-compose port app 3000)"
5644
echo "http://$(docker-compose port mail 1080)"
5745
```
5846

47+
### Exposed Ports
48+
49+
The `docker-compose.yml` file does expose all relevant ports.
50+
But it does not assign them a well-known port.
51+
This means, that it is _intentionally_ not possible to access the main application using `http://localhost:3000`!
52+
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).
53+
54+
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).
55+
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.
56+
(Because Docker will handle the port conflict for us.)
57+
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).
58+
5959
## First Login
6060

6161
Get the login information via the Rails console.

0 commit comments

Comments
 (0)