Compare commits

...

3 commits

Author SHA1 Message Date
54e3813b71
[docs] Changed build architecture for docker container ready to use
All checks were successful
ci/woodpecker/push/0-pre Pipeline was successful
ci/woodpecker/push/10-build-latest Pipeline was successful
ci/woodpecker/pr/0-pre Pipeline was successful
ci/woodpecker/pr/10-build-latest Pipeline was successful
2025-04-07 19:05:26 +02:00
3eb46b5495
Changed layout
All checks were successful
ci/woodpecker/push/0-pre Pipeline was successful
ci/woodpecker/push/10-build-latest Pipeline was successful
ci/woodpecker/pr/0-pre Pipeline was successful
ci/woodpecker/pr/10-build-latest Pipeline was successful
2025-04-06 20:12:04 +02:00
21a143f522
Changed README for more information
All checks were successful
ci/woodpecker/push/0-pre Pipeline was successful
ci/woodpecker/push/10-build-latest Pipeline was successful
ci/woodpecker/pr/0-pre Pipeline was successful
ci/woodpecker/pr/10-build-latest Pipeline was successful
2025-04-06 15:54:25 +02:00

View file

@ -1,24 +1,53 @@
[![status-badge](https://ci.hackmi.ch/api/badges/11/status.svg)](https://ci.hackmi.ch/repos/11) [![status-badge](https://ci.hackmi.ch/api/badges/11/status.svg)](https://ci.hackmi.ch/repos/11)
# goshorly
An easy self-hosted Link shortener in Golang with Redis <3 # Goshorly
**Easy-to-use, self-hosted link shortener built with Golang and Redis.**
Lightweight, fast, and Docker-compatible for seamless deployment. ❤️
--- ---
Docker Supported: ### Features
- linux/amd64
- linux/arm/v6
- linux/arm64/v8
See docker-compose.yml as example - Self-hosted: Take control of your link shortening service.
- Built with Golang: High performance and reliability.
- Redis Integration: Efficient data storage.
- Easy Deployment: Docker, Binary, Build it yourself
- Docker Support: ( linux/amd64, linux/arm64 )
--- ---
Live-Demo: ### Installation
- https://2slk.com Hosted by nitmali in Chinese #### Using Docker
(please refer to the example files!)
``` bash
git clone https://github.com/yourusername/goshorly.git
cd goshorly
docker-compose up -d
```
To simplify your deployment, we offer the following Docker tags:
- dev: Latest code from the main branch (experimental).
- latest: Latest stable release (may include breaking changes).
- Versioned Tags (vX, vX.X, vX.X.X): Specific release versions.
#### Using Binary
1. Download the latest binary from the releases.
2. Create an .env file (or use the .env.example)
and change the values for your environment.
3. Run the binary the terminal.
--- ---
**WARNING:** ### Contributing
- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
If you have an feature request, please do not hesitate to open an issue or merge request. We welcome contributions!
If you have feature requests, bug reports, or improvements, feel free to:
- Open an issue.
- Fork the repository.
- Create a new branch (feature/awesome-feature).
- Submit a pull request with detailed explanations.
- Submit a review.