Skip to content
This repository was archived by the owner on Apr 13, 2022. It is now read-only.

Commit 7a0f385

Browse files
committed
update docs
1 parent 1f35853 commit 7a0f385

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

.env.example

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
CLOUDFLARE_TOKEN=
2+
MYSQL_USERNAME=
3+
MYSQL_PASSWORD=
4+
AWS_ACCESS_KEY_ID=
5+
AWS_SECRET_ACCESS_KEY=

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,27 @@ jobs:
5656
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
5757
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
5858
```
59+
60+
## Local Testing 🧪
61+
62+
To test locally, it is highly suggested to use Docker (and docker-compose) as this is what runs in CI with GitHub Actions
63+
64+
Setup:
65+
66+
- Install [Docker](https://docs.docker.com/get-docker/)
67+
- Install [docker-compose](https://docs.docker.com/compose/install/)
68+
- Add the necessary secrets to your `.env` file
69+
70+
Run:
71+
72+
```bash
73+
TARKOV_CRON=update-hideout docker-compose up --build
74+
```
75+
76+
The syntax of the command above can be explained as follows:
77+
78+
```bash
79+
TARKOV_CRON=<cron-command-to-run> docker-compose up --build
80+
```
81+
82+
> Where `<cron-command-to-run>` is the name of a script in the `./jobs` folder

0 commit comments

Comments
 (0)