Skip to content

Commit d4b0872

Browse files
committed
document the Makefile commands; link to solid forum
1 parent 912aace commit d4b0872

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,40 @@ Containerized version of node-solid-server
44

55
## How to use
66

7-
This is still work in progress and not meant to be used yet.
7+
This is still work in progress and not meant to be used in production yet.
8+
9+
If you want to experiment with the image and/or contribute to its development,
10+
please read the rest of this ReadMe.
811

912
## Run tests
1013

11-
```
14+
```bash
1215
make test
1316
```
1417

15-
The first run might take a while, since the image has to be build. Follow up test runs will be faster.
18+
The first run might take a while, since the image has to be build. Follow up test runs will be faster.
19+
20+
## Start & stop locally
21+
22+
Build and run a local container named solid-server via
23+
24+
```bash
25+
make start
26+
```
27+
28+
and stop it via
29+
30+
```bash
31+
make stop
32+
```
33+
34+
## Inspect & debug
35+
36+
To start a shell in a running container (started with `make start`) run `make attach`.
37+
38+
To just run a shell in the built image (without starting solid) run `make inspect`.
39+
40+
## Feedback & Discussion
41+
42+
There is a [topic in the Solid Forum](https://forum.solidproject.org/t/official-solid-docker-image/748/5),
43+
you are welcome to join in.

0 commit comments

Comments
 (0)