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
## Acknowledgements
This project was inspired by and modified from Edward Shen's [Shlink extension][shlink-extension]. Modifications include:
1. Rewriting the backend code to contact a Chhoto URL server, rather than a Shlink server.
2. Changing the appearance of the `options.html` page.
3. Removing options which were either not possible to implement (because of the Chhoto URL server's limitations), or were not practical.
4. Optimizing code where possible.
5. Et cetera
## Information
| Syncing from (main repository) | Syncing to | Syncing every |
| ----------------------------------------------------- | ----------------------------------------------------- | ------------- |
| https://github.com/SolninjaA/Chhoto-URL-Extension | https://git.solomon.tech/solomon/Chhoto-URL-Extension | 8 hours |
[chhoto-github]: https://github.com/SinTan1729/chhoto-url
[install-instructions]: https://github.com/SinTan1729/chhoto-url#usage
[tabs-api]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs
[notif-api]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/notifications
[clipboard-api]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/clipboard
[storage-api]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage
[host-permission]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions#host_permissions
[context-menus]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/menus
[shlink-extension]: https://github.com/edward-shen/shlink
