Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swisstopo/swissgeol-viewer-app-abbreviator
swissgeol URL Shortener
https://github.com/swisstopo/swissgeol-viewer-app-abbreviator
Last synced: 9 days ago
JSON representation
swissgeol URL Shortener
- Host: GitHub
- URL: https://github.com/swisstopo/swissgeol-viewer-app-abbreviator
- Owner: swisstopo
- License: other
- Created: 2021-12-23T14:00:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T11:51:15.000Z (6 months ago)
- Last Synced: 2024-08-08T13:55:02.632Z (6 months ago)
- Language: Rust
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 16
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# abbreviator
URL Shortener, originally developed for the [`swissgeol`]("https://github.com/swissgeol/ngm") subsurface viewer.
## Quickstart
Spawn the docker image built from the `main` branch.
```bash
# run
docker run -d -p 8080:8080 \
-e DATABASE_URL='sqlite::memory:' \
-e HOST_WHITELIST='viewer.swissgeol.ch' \
ghcr.io/swisstopo/swissgeol-viewer-app-abbreviator:main
```
This exposes the service on `localhost:8080` with an in-memory sqlite database.
Sample request to shorten a url:
```bash
curl -v localhost:8080/ -d '{ "url": "https://viewer.swissgeol.ch/?layers=ch.swisstopo.geologie-geocover" }'
```
The `Location` header contains the shortened url to retrieve the original url:
```bash
# replace id with the last path segment of the shortened url
curl -v localhost:8080/{id}
```
This returns a response with status `301` and the original url in the `Location` header.
## Endpoints
### `POST /`
Expects a json body of the form:
```json
{
"url": "http://some.host/..."
}
```
Returns an empty response with status `201 Created` and the shortened url in the `Location` header.
### `GET /{id}`
Returns an empty response with status `301 Moved Permanently` and the original url in the `Location` header.
### `GET /health_check`
Checks the connection to the database and returns the `CARGO_PKG_VERSION` environment variable on success, `503 Service Unavailable` otherwise.
## Develop
[Install Rust](https://www.rust-lang.org/tools/install) then clone the project and run it locally.
```bash
# clone
git clone [email protected]:swisstopo/swissgeol-viewer-app-abbreviator.git
cd abbreviator
# build and test
cargo test
# run locally
cargo run
```
## Deploy
The following environment variables can be set to customize the service:
| Variable | Description |
| ---------------- | ---------------------------------------------------------------------- |
| `DATABASE_URL` | SQLite database url. |
| `HOST_WHITELIST` | Whitespace separated list of allowed hosts of the URL to be shortened. |
| `ID_LENGTH` | Length of the generated key, defaults to `5`. |
| `HOST` | Host the application listens to, defaults to `0.0.0.0`. |
| `PORT` | Port the application listens to, defaults to `8080`. |
To persist the database mount a volume or directory to `/storage` and let the `DATABASE_URL` point to there.
```bash
# build & run
docker build -t abbreviator:prod -f Dockerfile .
docker run -d -p 8080:8080 \
-e DATABASE_URL='sqlite:///storage/prod.db' \
-e HOST_WHITELIST='dev.swissgeol.ch int.swissgeol.ch viewer.swissgeol.ch swissgeol.ch' \
-v `pwd`:/storage \
abbreviator:prod
```
The app runs with an unprivileged user `appuser` that gets write access on startup, see [entrypoint.sh](./entrypoint.sh)
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.