standardnotes/standardnotes-extensions2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated README to reflect docker hub container

Browse Source
This commit is contained in:
mtoohey31
2021-01-28 00:14:20 -05:00
parent 9fce87ccd9
commit 8a43b5cdf6
1 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -63,20 +63,14 @@ https://your-domain.com/extensions/index.json
### Docker
* To via Docker, clone the repository, set up the .env file, and optionally modify the `extensions` directory, following the instructions above.
* Next, build the container:
```bash
$ docker build -t standardnotes-extensions .
```
* Then run the container, specifying the mount points for the `.env` file, the `extensions` directory, and the `public` directory, where the output will be placed:
* Then pull and run run the container, specifying the mount points for the `.env` file, the `extensions` directory, and the `public` directory, where the output will be placed:
```bash
$ docker run \
-v $PWD/.env:/build/.env \
-v $PWD/extensions:/build/extensions \
-v $PWD/public:/build/public \
standardnotes-extensions
mtoohey/standardnotes-extensions
```
#### Docker Compose
@@ -92,8 +86,7 @@ services:
- standardnotes-extensions:/usr/share/nginx/html
standardnotes-extensions:
build:
context: $HOME/standardnotes-extensions/
image: mtoohey/standardnotes-extensions
restart: "no"
volumes:
- $HOME/standardnotes-extensions/.env:/build/.env
@@ -105,9 +98,17 @@ volumes:
name: standardnotes-extensions
```
This snippet will handle the building of the extension creation-container, and place the result in the `standardnotes-extensions` volume, which can then be mounted in the nginx container so that it can be served as demonstrated in the instructions below.
This snippet will handle the building of the extension creation-container, and place the result in the `standardnotes-extensions` volume, which can then be mounted in the nginx container so that it can be served as demonstrated in the instructions below. Note that it's necessary to include the `restart: "no"` flag, because the container is designed to stop after it has finished generating the extensions.
Please note that the confiuration snippet above is in no way a complete setup: you will still have to configure the nginx container and set up the syncing server containers.
Also, please note that the configuration snippet above is in no way a complete setup: you will still have to configure the nginx container and set up the syncing server containers.
### Docker Build
If you need to build the container, clone this repository, `cd` into it, and run the following command:
```bash
$ docker build -t standardnotes-extensions .
```
### Setup with nginx