jlelse
/
GoShort
1
Fork 0
Code Packages
Minimal URL shortener
10 Commits 1 Branch 0 Tags 137 KiB
Go 96.5%
Dockerfile 2%
Shell 1.5%
Go to file
Jan-Lukas Else 708de82c97 Add readme content 2020-03-29 19:10:07 +02:00
.gitignore Initial commit 2020-03-29 10:48:43 +02:00
Dockerfile Use libsqlite3 2020-03-29 11:02:04 +02:00
LICENSE Initial commit 2020-03-29 10:48:43 +02:00
README.md Add readme content 2020-03-29 19:10:07 +02:00
example-config.yaml Initial commit 2020-03-29 10:48:43 +02:00
go.mod Initial commit 2020-03-29 10:48:43 +02:00
go.sum Initial commit 2020-03-29 10:48:43 +02:00
main.go Directly join short link string 2020-03-29 19:05:01 +02:00

README.md

GoShort

GoShort is a simple URL shortener written in Go. It's minimal and only uses a simple SQLite database in the background.

Configuration

Configuration can be done with a simple config.{json|yaml|toml} file in the working directory or a subdirectory config.

These are the required config values:

  • password: Password to create or delete short links
  • shortUrl: The short base URL (without trailing slash!)
  • defaultUrl: The default URL to which should be redirected when no slug is specified

These are optional config values:

  • dbPath: Relative path where the database should be saved

See the example-config.yaml file for an example configuration.

Create a new short link

To create a new short link, open "shortUrl + /s?url= + URL to shorten" in the browser. If you want, you can append &slug= with the preferred slug.

Delete a short link

To delete a short link, open "shortUrl + /d?slug= + slug to delete" in the browser.

License

GoShort is licensed under the MIT license, so you can do basically everything with it, but nevertheless, please contribute your improvements to make GoShort better for everyone. See the LICENSE file.