neil/silverbullet
1
0
Fork 0
Code

add docker setup

Browse Source
This commit is contained in:
Ahmed Nour Eldin 2022-07-18 03:32:08 +02:00 committed by GitHub
parent d6398d7d89
commit d56f1b87d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -37,6 +37,22 @@ More documentation can be found in the [docs space](https://github.com/zefhemel/
* **Extensible** through plugs. * **Extensible** through plugs.
## Installing and running Silver Bullet ## Installing and running Silver Bullet
## Start with docker
First you have to clone the repo, then configure your port, space/directory in .env file
then run
```
docker compose up
```
then open your browser and ROCK!
e.g.
```
localhost:PORT
```
## Start without docker
To run a release version, you need to have a recent version of npm (8+) and node.js (16+) installed as well as some basic build infrastructure (make, cpp). Silver Bullet has only been tested on MacOS and Linux thus far. To run a release version, you need to have a recent version of npm (8+) and node.js (16+) installed as well as some basic build infrastructure (make, cpp). Silver Bullet has only been tested on MacOS and Linux thus far.
To install and run, create a folder for your pages (can be empty or an existing folder with `.md` files) and run: To install and run, create a folder for your pages (can be empty or an existing folder with `.md` files) and run: