diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..8f10b0e --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +REPOSITORY_LOCATION= +CONFIG_LOCATION= +TIMEZONE= diff --git a/README.md b/README.md index bc15d67..5060937 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ Clone this repository Enter the repository and run `npm install`. This will install all the required dependencies. ## Step 3 -Edit the `docker-compose.yml` file. +Make a copy from `.env.example` file and rename it `.env`. -Replace `` with the full path to your repository. +Add the full path of your repository on the `REPOSITORY_LOCATION` variable. -Replace `` with the directory in which you would like to store your configuration. +Add the directory in which you would like to store your configuration on the `CONFIG_LOCATION` variable. -Replace `` with your timezone. +Add your timezone on the `TIMEZONE` variable ## Step 4 Run the command `docker build -t librarian .` and then `docker-compose up -d` diff --git a/src/configuration.yaml.default b/configuration.yaml.default similarity index 100% rename from src/configuration.yaml.default rename to configuration.yaml.default diff --git a/docker-compose.yml b/docker-compose.yml index c573bb4..177d9b6 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -7,8 +7,8 @@ services: command: > node index.js volumes: - - :/usr/src/bot - - :/.store + - ${REPOSITORY_LOCATION}:/usr/src/bot + - ${CONFIG_LOCATION}:/.store environment: - - TZ= + - TZ=${TIMEZONE} restart: unless-stopped \ No newline at end of file