Skip to content

Commit e67c714

Browse files
committed
update readme
1 parent 0ee9102 commit e67c714

1 file changed

Lines changed: 27 additions & 29 deletions

File tree

README.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,7 @@ rsync -arv -e 'ssh -p 2222' /path/to/geodata/ geoserver@georchestra-127-0-0-1.ni
120120

121121
Files uploaded into this volume will also be available to the geoserver instance in `/mnt/geoserver_geodata/`.
122122

123-
Emails sent by the SDI (eg when users request a new password) will not be relayed on the internet but trapped by a local SMTP service.
124-
These emails can be read on https://georchestra-127-0-0-1.nip.io/webmail/ (with login `smtp` and password `smtp`).
125-
123+
Emails sent by the SDI (eg when users request a new password) will not be relayed on the internet but trapped by a local SMTP service.
126124

127125
## Locally trust the TLS certificate for geOrchestra
128126

@@ -168,17 +166,12 @@ These docker-compose files describe:
168166
* how they are linked together,
169167
* where the configuration and data volumes are
170168

171-
The `docker-compose.override.yml` file adds services to interact with your geOrchestra instance (they are not part of geOrchestra "core"):
172-
* reverse proxy / load balancer
173-
* ssh / rsync services,
174-
* smtp, webmail.
175-
176169
**Feel free to comment out the apps you do not need**.
177170

178171
The base docker composition does not include any standalone geowebcache instance, nor the atlas module.
179172
If you need them, you have to include the corresponding complementary docker-compose file at run-time:
180173
```
181-
docker compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.gwc.yml -f docker-compose.atlas.yml up
174+
docker compose -f docker-compose.yml up
182175
```
183176

184177
## Upgrading
@@ -195,11 +188,11 @@ To upgrade, we recommend you to:
195188
This docker composition supports environment variables, if you need to customize something it might be in the different environment variables files.
196189

197190
Here is the list of these files:
198-
- [.envs-common](.envs-common)
199-
- [.envs-database-datafeeder](.envs-database-datafeeder)
200-
- [.envs-database-georchestra](.envs-database-georchestra)
201-
- [.envs-hosts](.envs-hosts)
202-
- [.envs-ldap](.envs-ldap)
191+
- [.envs-common](envs/.envs-common)
192+
- [.envs-database-datafeeder](envs/.envs-database-datafeeder)
193+
- [.envs-database-georchestra](envs/.envs-database-georchestra)
194+
- [.envs-hosts](envs/.envs-hosts)
195+
- [.envs-ldap](envs/.envs-ldap)
203196

204197
If you add variables, be careful because it might be added into the wrong/unwanted container.
205198

@@ -220,7 +213,7 @@ Most changes will require a service restart, except maybe updating viewer contex
220213

221214
In order to have Kibana up and running, you will need to:
222215
1. After Elasticsearch up and healthy, launch the command `docker compose exec -it elasticsearch bin/elasticsearch-reset-password -u kibana_system`. It will ask to fill a password for the `kibana_system` user.
223-
2. Uncomment and fill this password into the `.envs-elastic` file.
216+
2. Uncomment and fill this password into the `envs/.envs-elastic` file.
224217
3. Enable kibana server with `scale: 1` in `docker-compose.yml`.
225218
4. Start Kibana with `docker compose up -d kibana`.
226219

@@ -285,11 +278,11 @@ https://techoverflow.net/2019/04/17/how-to-disable-elasticsearch-disk-quota-wate
285278

286279
Beside georchestra/docker directory, you need to clone [georchestra/georchestra repo](https://github.com/georchestra/georchestra) first.
287280

288-
Next, install maven to execute [main georchestra Makefile](https://github.com/georchestra/georchestra/blob/master/Makefile) on each modification (e.g console, security-proxy, whatever you change).
281+
Next, install maven to execute [main georchestra Makefile](https://github.com/georchestra/georchestra/blob/master/Makefile) on each modification (e.g console, gateway, whatever you change).
289282

290-
For example, if you change some security-proxy code, use :
283+
For example, if you change some gateway code, use :
291284

292-
`make docker-build-proxy`
285+
`make docker-build-gateway`
293286

294287
... to execute easily this maven command :
295288

@@ -305,25 +298,30 @@ You can now test modifications locally with the current FQDN (by default `georch
305298

306299
**3. Debug**
307300

308-
Open `docker/docker-compose.yml` and identify `proxy` section.
301+
Open `docker/docker-compose.yml` and identify `gateway` section.
309302

310-
Change `proxy` section to insert some JAVA options and ports `5005` to get :
303+
Change `gateway` section to insert some JAVA options and ports `5005` to get :
311304

312305
```
313-
proxy:
314-
image: georchestra/security-proxy:latest
306+
gateway:
307+
image: georchestra/gateway:latest-debug
315308
depends_on:
316-
- ldap
317-
- database
309+
- database
318310
volumes:
319-
- georchestra_datadir:/etc/georchestra
311+
- ./config:/etc/georchestra
320312
environment:
321-
- JAVA_OPTIONS=-Dorg.eclipse.jetty.annotations.AnnotationParser.LEVEL=OFF -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005
322-
- XMS=256M
323-
- XMX=1G
313+
- JAVA_OPTIONS=-Dorg.eclipse.jetty.annotations.AnnotationParser.LEVEL=OFF -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005
314+
- XMS=256M
315+
- XMX=1G
316+
env_file:
317+
- ./envs/.envs-common
318+
- ./envs/.envs-ldap
319+
- ./envs/.envs-hosts
320+
- ./envs/.envs-database-georchestra
324321
restart: always
325322
ports:
326-
- "5005:5005"
323+
- "5005:5005"
324+
- "8080:8080"
327325
```
328326

329327
Apply Docker changes :

0 commit comments

Comments
 (0)