ForgeFlux/webfinger-test
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

feat: init README

Browse source
This commit is contained in:
Aravinth Manivannan 2023-09-06 19:53:32 +05:30
parent 2bb516c89c
commit 40dd327046
Signed by: realaravinth
GPG key ID: F8F50389936984FF
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md Normal file
View file

@ -0,0 +1,25 @@
# WebFinger tests for ForgeFlux/ftest
## Environment Variables
Please see [`.env_sample`](./.env_sample)
| NAME | Purpose | Example |
| ------------------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| `FTEST_AUTH` | Authorization token for uploading test results to ftest server | a random-generated string that will be provided by ftest server |
| `FTEST_TARGET_HOST` | The URL of the implementation's instance against which tests will be run | `http://localhost:3000`, if Forgejo or any other WebFinger implementation is running on localhost at port 3000 |
| `FTEST_USER` | address of the actor against which WebFinger tests will be run | `john@localhost:3000`. User `john` should exist on the instance |
## Usage
```bash
cp .env_sample .env # edit and populate .env with the right values
source .env
python run.py
```
## TODO
- [ ] Write code to upload to ftest server
- [ ] Package Docker container
- [ ] Upload to Docker Hub