From 40dd327046b77090e654feb01b58ca7131f8da7b Mon Sep 17 00:00:00 2001 From: Aravinth Manivannan Date: Wed, 6 Sep 2023 19:53:32 +0530 Subject: [PATCH] feat: init README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2b747f --- /dev/null +++ b/README.md @@ -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