Skip to content

Commit 0457441

Browse files
Adds some additional information about log files to README.
1 parent 69dfad6 commit 0457441

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,15 @@
88

99
----
1010

11+
### First steps:
12+
13+
14+
- Make sure, you have a valid Structr license.key file and copy it to ./structr/license.key. If you want to run the community edition of Structr, you can create an empty file and move it also to ./structr/license.key.
15+
1116
### Usage with docker-compose:
1217
##### Initial setup:
1318

19+
- Run the setup.sh script before starting the stack, so all necessary volume folders for mounting to the containers are created. (Only for Unix and macOS users)
1420
- Copy your license.key file to ./structr/license.key
1521
- Run `docker-compose build`
1622

@@ -26,11 +32,16 @@
2632
- `note the container id`
2733
- `docker exec -it <Unique identifier for container> /bin/sh`
2834

35+
##### Inpecting the service log files
36+
- `docker-compose logs` will print out the server.log of structr and the neo4j.log of Neo4j
37+
- The Structr container server.log will also be written to ./volumes/structr-logs/server.log, the Neo4j debug.log and neo4j.log will be written to ./volumes/neo4j-logs/*.log
38+
2939
----
3040

3141
### Usage with docker swarm:
3242
##### Initial setup:
3343

44+
- Run the setup.sh script before starting the stack, so all necessary volume folders for mounting to the containers are created. (Only for Unix and macOS users)
3445
- copy your license.key file to ./structr/license.key
3546
- run `docker swarm init`
3647

@@ -50,6 +61,9 @@
5061
- Run `docker stack ps structr` to get a list of all tasks in the structr stack
5162
- Run `docker stack services structr` to get a list of all services in the structr stack
5263

64+
##### Inpecting the service log files
65+
- The Structr container server.log will be written to ./volumes/structr-logs/server.log, the Neo4j debug.log and neo4j.log will be written to ./volumes/neo4j-logs/*.log
66+
5367
----
5468

5569
### Customizing Ressources

0 commit comments

Comments
 (0)