goshorly/README.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

2021-12-07 18:32:48 +00:00
![](https://git.ucode.space/Phil/goshorly/badges/main/pipeline.svg)
2021-12-07 13:55:58 +00:00
# goshorly
2022-01-23 21:21:49 +00:00
An easy self-hosted Link shortener in Golang with Redis <3 [Live-Demo](https://gly.one)
---
## Supported architectures
### Docker
- amd64, arm64
- other versions can be build manually (via docker build)
## Binary Build
- linux (amd64,arm64)
- darwin (amd64,arm64)
- windows (amd64)
- other versions can be build manually (via go build)
---
2021-12-07 19:43:42 +00:00
**WARNING:**
2022-01-21 15:25:26 +00:00
- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
2021-12-07 19:43:42 +00:00
2021-12-07 22:41:52 +00:00
If you have an feature request, please do not hesitate to open an issue or merge request.
2022-01-11 12:19:05 +00:00
Available Docker tags:
- https://git.ucode.space/Phil/goshorly/container_registry/1
2022-01-23 21:21:49 +00:00
## Install with Docker
2021-12-07 19:43:42 +00:00
Installation with Docker-Compose (with no reverse proxy / own proxy):
2021-12-07 17:19:29 +00:00
```bash
mkdir goshorly
cd goshorly
wget https://git.ucode.space/Phil/goshorly/-/raw/main/docker-compose.yml
2021-12-07 19:43:42 +00:00
nano docker-compose.yml # Change the environment variables to your needs
2021-12-07 17:19:29 +00:00
docker-compose up -d
```
2021-12-07 19:43:42 +00:00
Installation with Docker-Compose (built in proxy / caddy as reverse proxy):
2021-12-07 18:32:48 +00:00
```bash
mkdir goshorly
cd goshorly
wget https://git.ucode.space/Phil/goshorly/-/raw/main/docker-compose-proxy.yml
mv docker-compose-proxy.yml docker-compose.yml
2021-12-07 19:43:42 +00:00
nano docker-compose.yml # Change the command line on caddy to your domain & environment variables to your needs
2021-12-07 18:32:48 +00:00
docker-compose up -d
```
2022-01-23 21:21:49 +00:00
## Install with Binary version
- WIP