Changed README
This commit is contained in:
parent
469d94fb98
commit
0af8219322
1 changed files with 17 additions and 4 deletions
21
README.md
21
README.md
|
@ -1,11 +1,19 @@
|
||||||
![](https://git.ucode.space/Phil/goshorly/badges/main/pipeline.svg)
|
![](https://git.ucode.space/Phil/goshorly/badges/main/pipeline.svg)
|
||||||
# goshorly
|
# goshorly
|
||||||
|
|
||||||
An easy self-hosted Link shortener in Golang with Redis <3
|
An easy self-hosted Link shortener in Golang with Redis <3 [Live-Demo](https://gly.one)
|
||||||
|
|
||||||
[Live-Demo](https://gly.one) | Stable Build
|
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
## 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)
|
||||||
|
---
|
||||||
**WARNING:**
|
**WARNING:**
|
||||||
- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
|
- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
|
||||||
|
|
||||||
|
@ -14,6 +22,8 @@ If you have an feature request, please do not hesitate to open an issue or merge
|
||||||
Available Docker tags:
|
Available Docker tags:
|
||||||
- https://git.ucode.space/Phil/goshorly/container_registry/1
|
- https://git.ucode.space/Phil/goshorly/container_registry/1
|
||||||
|
|
||||||
|
|
||||||
|
## Install with Docker
|
||||||
Installation with Docker-Compose (with no reverse proxy / own proxy):
|
Installation with Docker-Compose (with no reverse proxy / own proxy):
|
||||||
```bash
|
```bash
|
||||||
mkdir goshorly
|
mkdir goshorly
|
||||||
|
@ -32,3 +42,6 @@ mv docker-compose-proxy.yml docker-compose.yml
|
||||||
nano docker-compose.yml # Change the command line on caddy to your domain & environment variables to your needs
|
nano docker-compose.yml # Change the command line on caddy to your domain & environment variables to your needs
|
||||||
docker-compose up -d
|
docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Install with Binary version
|
||||||
|
- WIP
|
Loading…
Reference in a new issue