From 7ba38db0cc200cd3dae529f1035002413115a536 Mon Sep 17 00:00:00 2001 From: iPromKnight Date: Sun, 4 Feb 2024 15:45:32 +0000 Subject: [PATCH] remove .env and add .env.example - add readme instructions --- .env => .env.example | 0 .gitignore | 1 + README.md | 15 ++++++++++++++- 3 files changed, 15 insertions(+), 1 deletion(-) rename .env => .env.example (100%) diff --git a/.env b/.env.example similarity index 100% rename from .env rename to .env.example diff --git a/.gitignore b/.gitignore index e40d9682..0c759aa9 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ .now .DS_Store .idea +.env ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. diff --git a/README.md b/README.md index 4dc31b0f..e2aa27db 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ A self-hosted Stremio addon for streaming torrents via a debrid service. - [Overview](#overview) - [Using](#using) - [Initial setup (optional)](#initial-setup-optional) + - [Environment Setup](#environment-setup) - [Run the project](#run-the-project) - [Monitoring with Grafana and Prometheus (Optional)](#monitoring-with-grafana-and-prometheus-optional) - [Accessing RabbitMQ Management](#accessing-rabbitmq-management) @@ -60,11 +61,22 @@ We can search DebridMediaManager hash lists which are hosted on GitHub. This all GithubSettings__PAT= ``` + +### Environment Setup + +Before running the project, you need to set up the environment variables. Copy the `.env.example` file to `.env`: + +```sh +cp .env.example .env +``` + +Then set any of th values you'd like to customize. + ### Run the project Open a terminal in the directory and run the command: -``` sh +```sh docker compose up -d ``` @@ -108,6 +120,7 @@ Now, you can use these dashboards to monitor RabbitMQ and Postgres metrics. Note: If you encounter issues with missing or unavailable data in Grafana, please ensure on [Prometheus's target page](http://127.0.0.1:9090/targets) that the RabbitMQ target is up and running. + ## Importing external dumps A brief record of the steps required to import external data, in this case the rarbg dump which can be found on RD: