soyprano/README.md
2025-04-09 15:12:34 +02:00

39 lines
1.2 KiB
Markdown

# Soyprano
Soyprano is a privacy-respecting frontend to Tenor
This project is incomplete. The only supported endpoints are /view (gif) and /search (search).
# Support
Join our [XMPP MUC](xmpp:home@room.telepath.im?join). Expect no support, I frankly don't care.
# Instances
See instances.json
# Run your own instance
## Dependencies
This program is written in Guile Scheme.
You will need need `guile`, `guile-gnutls`, and `guile-lib`.
## Running
0. Install the dependencies
1. Clone the repository using `git clone https://forge.fsky.io/clombrong/soyprano`
2. Run `guile -L . soyprano.scm`
3. Connect to http://localhost:8080 (or point your reverse proxy to it)
4. Profit
## Environment
`PATCHES_URL` - Link to any patches that were applied. Necessary if there are any. Do not set if there aren't.
The following are optional.
`SOYPRANO_PORT` - What port to run on (default `8080`).
`SOYPRANO_ASSETS` - Path for the Soyprano assets (default `assets/`).
## Notes
When using a service manager (e.g. the GNU shepherd), make sure the stop signal is set to SIGINT, or 2. This will prevent EADDRINUSE.
## Container
To build as an OCI image, run `guix pack -f docker --entry-point=bin/soyprano soyprano`.