diff --git a/README.md b/README.md index 20da23c..d0b3b0a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ -# Wiki +# Halia Wiki +## Usage +Wiki for the Halia infrastructure, powered by Bookstack. -Wiki for the Halia infrastructure, powered by Bookstack \ No newline at end of file +## Requirements +To deploy this instance, you only need to install `docker-compose` and `docker`. + +## Installation +To deploy a copy of this instance, you might want to modify where the volumes are pointing to. + +Also, remember to copy `.env.sample` to `.env` and fill the variables according yo your setup. + +Then run + +``` +./start.sh +``` + + +All necessary images should be downloaded automatically and the service should be started in the background.