Skip to content

Commit 51138a9

Browse files
Merge pull request #53 from bufferoverflow/docs/readme-improvements
docs: explain how to overwrite default conf with dockerfile
2 parents aea03ed + 76ad223 commit 51138a9

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ In order to avoid too many authentication requests to the underlying
150150
gitlab instance, the plugin provides an in-memory cache that will save
151151
the detected groups of the users for a configurable ttl in seconds.
152152

153-
No clear-text password will is saved in-memory, just an SHA-256 hash of
153+
No clear-text password is saved in-memory, just an SHA-256 hash of
154154
the user+password, plus the groups information.
155155

156156
By default, the cache will be enabled and the credentials will be stored
@@ -177,6 +177,13 @@ docker-compose up --build -d
177177
- login to the npm registry [http://localhost:4873](http://localhost:4873) via browser
178178
- publish your packages via command line
179179

180+
The Dockerfile provides a [default configuration file](conf/docker.yaml)
181+
that is internally available under `/verdaccio/config/conf.yaml`. In order
182+
to overwrite this configuration you can provide your own file and mount it
183+
on docker startup with the `--volume` option, or equivalent mechanism
184+
(e.g. ConfigMaps on Kubernetes / OpenShift with the
185+
[helm chart](https://github.com/helm/charts/tree/master/stable/verdaccio)).
186+
180187
## Create a Release
181188

182189
Run one of the following command to create a release:

0 commit comments

Comments
 (0)