Skip to content

Commit

Permalink
remove .env and add .env.example - add readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
iPromKnight committed Feb 4, 2024
1 parent e461e26 commit 7ba38db
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
File renamed without changes.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -60,11 +61,22 @@ We can search DebridMediaManager hash lists which are hosted on GitHub. This all
GithubSettings__PAT=<YOUR TOKEN HERE>
```


### 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
```

Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 7ba38db

Please sign in to comment.