Skip to content

Commit 654b95c

Browse files
authored
Merge pull request #1473 from vemonet/fix/docker-docs
Fix Docker instructions in the main README
2 parents 92f5fa2 + 9edf274 commit 654b95c

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ $ solid start --help
218218
--support-email [value] The support email you provide for your users (not required)
219219
-q, --quiet Do not print the logs to console
220220
-h, --help output usage information
221-
```
221+
```
222222

223223
Instead of using flags, these same options can also be configured via environment variables taking the form of `SOLID_` followed by the `SNAKE_CASE` of the flag. For example `--api-apps` can be set via the `SOLID_API_APPS`environment variable, and `--serverUri` can be set with `SOLID_SERVER_URI`.
224224

@@ -228,49 +228,52 @@ Configuring Solid via the config file can be a concise and convenient method and
228228

229229
## Use Docker
230230

231-
Pull with:
231+
232+
### Production usage
233+
234+
See the [documentation to run Solid using docker and docker-compose](https://github.com/solid/node-solid-server/tree/master/docker-image).
235+
236+
We have automatic builds set up, so commits to master will trigger a build of https://hub.docker.com/r/nodesolidserver/node-solid-server.
237+
238+
### Development usage
239+
240+
If you want to use Docker in development, then you can build it locally with:
232241

233242
```bash
234-
docker pull nodesolidserver/node-solid-server
243+
git clone https://github.com/solid/node-solid-server
244+
cd node-solid-server
245+
docker build -t node-solid-server .
235246
```
236247

237248
Run with:
238249
```bash
239-
docker run -p 8443:8443 --name solid nodesolidserver/node-solid-server
250+
docker run -p 8443:8443 --name solid node-solid-server
240251
```
241252

242253
This will enable you to login to solid on https://localhost:8443 and then create a new account
243254
but not yet use that account. After a new account is made you will need to create an entry for
244255
it in your local (/etc/)hosts file in line with the account and subdomain, i.e. --
256+
245257
```pre
246258
127.0.0.1 newsoliduser.localhost
247259
```
248-
Then you'll be able to use solid as intended.
249260

250261
You can modify the config within the docker container as follows:
251262

252-
- Copy the config to the current directory with:
253-
```
263+
- Copy the `config.json` to the current directory with:
264+
```bash
254265
docker cp solid:/usr/src/app/config.json .
255266
```
256267
- Edit the `config.json` file
257268
- Copy the file back with
258-
```
269+
```bash
259270
docker cp config.json solid:/usr/src/app/
260271
```
261272
- Restart the server with
262-
```
273+
```bash
263274
docker restart solid
264275
```
265276

266-
If you want to help improve the Docker image, then you can build it locally with:
267-
```bash
268-
git clone https://github.com/solid/node-solid-server
269-
cd node-solid-server
270-
docker build .
271-
```
272-
We have automatic builds set up, so commits to master will trigger a build of https://hub.docker.com/r/nodesolidserver/node-solid-server.
273-
274277
## Library Usage
275278

276279
### Install Dependencies

0 commit comments

Comments
 (0)