diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4c7b47 --- /dev/null +++ b/README.md @@ -0,0 +1,99 @@ +# Chhoto URL Extension +This extension allows for easy, shortened URL link generation using a [Chhoto URL server][chhoto-github]. + +## Requirements +### Chhoto URL server +In order to use this extension, a [Chhoto URL server][chhoto-github] is required. If you don't have one already, refer to the [installation instructions][install-instructions]. + +### Set the `api_key` environment variable +The `api_key` environment variable must be configured in the [Chhoto URL server][chhoto-github] configuration. + +For example, using Docker Compose, you can add the `api_key` environment variable under `environment:` like so: +```yaml +environment: + - api_key=SECURE_API_KEY +``` + +Alternatively, using Docker Run, you can add `-e api_key="SECURE_API_KEY" \` to the command arguments. + +**Note:** The Chhoto URL server will output a warning if this is insecure, and a generated API key will be output. You may use that value if you can't think of a secure key, or you may generate an API key using your operating system's terminal. + +For example, on Linux, you could generate an API key by running `tr -dc A-Za-z0-9