kreativmonkey
/
shrty
1
0
Fork 0
Code Issues 10 Pull Requests Releases Wiki Activity

Rename Sgot to Shrty

Browse Source
master
Sebastian Preisner 7 years ago
parent 517d6be4c7
commit dea368d08b
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File

12
README.md
Unescape Escape View File

@ -1,5 +1,5 @@
# Sgot # Shrty
Sgot is a lightwaight, self-hostable open-source link shortening web application with a Restful API. It allows you to host your own URL shortener to gain control over you data. Shrt is inspired by [Polr](https://polr.me/index.php), a php based url shortener. Shrty is a lightwaight, self-hostable open-source link shortening web application with a Restful API. It allows you to host your own URL shortener to gain control over your data. Shrty is inspired by [Polr](https://polr.me/index.php), a php based url shortener.
## Features ## Features
@ -8,6 +8,8 @@ Sgot is a lightwaight, self-hostable open-source link shortening web application
- [x] Simple database Json file - [x] Simple database Json file
- [x] Restful API - [x] Restful API
- [x] Simple Click Statistik - [x] Simple Click Statistik
- [ ] Key protected API
- [ ] Nice overfewpage for shorted URLs
- [ ] Delete URL - [ ] Delete URL
- [ ] Login - [ ] Login
@ -15,15 +17,15 @@ Sgot is a lightwaight, self-hostable open-source link shortening web application
Clone the Repository and build the Application by using `go build .` Clone the Repository and build the Application by using `go build .`
Start Sgot by the following commant `./sgot &` Start Shrty by the following commant `./sgot &`
| Flag | Usage | Default | | Flag | Usage | Default |
| -------- | -------------------------------------- | ------------------------------------ | | -------- | -------------------------------------- | ------------------------------------ |
| -host | setup the host to listen on | localhost | | -host | setup the host to listen on | localhost |
| -port | Setup the port to listen on | 6889 | | -port | Setup the port to listen on | 6889 |
| -apikey | Define the key to connect with the API | "thisIsNotASecretTokenNow" | | -apikey | Define the key to connect with the API | "thisIsNotASecretTokenNow" |
| -db-file | Setup the DB file to use | ./sgot.db | | -db-file | Setup the DB file to use | ./shrty.db |
| -title | Service title | Sgot | | -title | Service title | Shrty |
| -domain | Domain for the redirection link | The domain your service is available | | -domain | Domain for the redirection link | The domain your service is available |
## API ## API

Write Preview
Loading…
Cancel
Save