https://github.com/hoverth/ssurlss
Super Simple URL Shortener Service
https://github.com/hoverth/ssurlss
docker rust url-shortener
Last synced: 3 months ago
JSON representation
Super Simple URL Shortener Service
- Host: GitHub
- URL: https://github.com/hoverth/ssurlss
- Owner: Hoverth
- License: agpl-3.0
- Created: 2024-10-27T04:03:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-23T01:23:45.000Z (about 1 year ago)
- Last Synced: 2024-11-23T02:17:42.833Z (about 1 year ago)
- Topics: docker, rust, url-shortener
- Language: Rust
- Homepage:
- Size: 91.8 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SSURLSS
##### super simple URL shortener service
A very lightweight URL shortener.
## Usage
### Standalone
You can use ssurlss standalone by manually compiling & installing it
in a directory. Running it for the first time will generate the
`ssurlss.toml` config file, which can be edited, and the changes
will take affect once ssurlss is restarted.
### Docker
#### Using GitHub Packages
Use the supplied
[deploy.docker-compose.yml](https://github.com/Hoverth/ssurlss/blob/main/deploy.docker-compose.yml)
, or simply run
```sh
docker run -p 8000:8000 \
-v ./ssurlss.toml:/ssurlss.toml \
ghcr.io/hoverth/ssurlss:main
```
#### Build yourself
You can build the docker image using supplied `docker-compose.yml`
using `docker-compose up` in a clone of this repo.
To use a specific release, change the `build: .` to
`build: https://github.com/Hoverth/ssurlss.git#v1.1.0`
(just change the `v1.1.0` to whatever
[release](https://github.com/Hoverth/ssurlss/releases) you want to target).
## Configuration
There are several options to configure ssurlss, which can both be
controlled via changes in the config, or set via environment
variables (which override the config file configuration).
The following list is formatted as: `- toml_name (ENVNAME, default value) Notes`
- host (HOST, `"http://localhost:8000"`) This is only really needed
if allowing new entries
- url_path (URLPATH, `""`) The path that the application should use,
e.g. `/ssurlss/`
- link_path (LINKPATH, `"links"`) The subpath that links should use,
e.g. `/link/`
- port (PORT, `8000`) The port for the server to listen on, if using
in docker just set the mapped port in the `docker-compose.yml`
- allow_new (ALLOWNEW/DISALLOWNEW, `true`) Setting either envvar to
1 will set the relevant value in the config.
- entries_len (no envvar, `0`) A helpful tracking value for admin
purposes, no environment variable and not used anywhere (write-only).
## License
This project is licensed under the AGPL v3. See `LICENSE` for details.