mirror of
https://github.com/knightcrawler-stremio/knightcrawler.git
synced 2024-12-20 03:29:51 +00:00
remove .env and add .env.example - add readme instructions
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@@ -2,6 +2,7 @@
|
|||||||
.now
|
.now
|
||||||
.DS_Store
|
.DS_Store
|
||||||
.idea
|
.idea
|
||||||
|
.env
|
||||||
|
|
||||||
## Ignore Visual Studio temporary files, build results, and
|
## Ignore Visual Studio temporary files, build results, and
|
||||||
## files generated by popular Visual Studio add-ons.
|
## files generated by popular Visual Studio add-ons.
|
||||||
|
|||||||
15
README.md
15
README.md
@@ -13,6 +13,7 @@ A self-hosted Stremio addon for streaming torrents via a debrid service.
|
|||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Using](#using)
|
- [Using](#using)
|
||||||
- [Initial setup (optional)](#initial-setup-optional)
|
- [Initial setup (optional)](#initial-setup-optional)
|
||||||
|
- [Environment Setup](#environment-setup)
|
||||||
- [Run the project](#run-the-project)
|
- [Run the project](#run-the-project)
|
||||||
- [Monitoring with Grafana and Prometheus (Optional)](#monitoring-with-grafana-and-prometheus-optional)
|
- [Monitoring with Grafana and Prometheus (Optional)](#monitoring-with-grafana-and-prometheus-optional)
|
||||||
- [Accessing RabbitMQ Management](#accessing-rabbitmq-management)
|
- [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=<YOUR TOKEN HERE>
|
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
|
### Run the project
|
||||||
|
|
||||||
Open a terminal in the directory and run the command:
|
Open a terminal in the directory and run the command:
|
||||||
|
|
||||||
``` sh
|
```sh
|
||||||
docker compose up -d
|
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.
|
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
|
## 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:
|
A brief record of the steps required to import external data, in this case the rarbg dump which can be found on RD:
|
||||||
|
|||||||
Reference in New Issue
Block a user