jlelse
/
GoShort
1
Fork 0
Code Actions Packages
Minimal URL shortener
40 Commits 1 Branch 0 Tags 131 KiB
Go 96.7%
Shell 1.7%
Dockerfile 1.6%
Go to file
Jan-Lukas Else d0e1530dab
Master workflow / Build Docker image (push) Successful in 9s Details
Try to build with Gitea Actions 		2023-04-29 16:19:54 +02:00
.gitea/workflows Try to build with Gitea Actions 2023-04-29 16:19:54 +02:00
templates Fix list 2021-08-11 15:16:52 +02:00
.drone.yml Upgrade dependencies, use Gitea container registry 2022-07-31 12:20:42 +02:00
.gitignore Some code improvements and updates 2021-08-10 22:34:25 +02:00
Dockerfile Update Go and dependencies 2023-04-27 17:05:25 +02:00
LICENSE Initial commit 2020-03-29 10:48:43 +02:00
README.md Add HTML forms for actions 2020-04-01 19:31:49 +02:00
database.go Use another sqlite library without cgo 2021-09-04 10:43:01 +02:00
example-config.yaml Initial commit 2020-03-29 10:48:43 +02:00
go.mod Update Go and dependencies 2023-04-27 17:05:25 +02:00
go.sum Update Go and dependencies 2023-04-27 17:05:25 +02:00
main.go Use another sqlite library without cgo 2021-09-04 10:43:01 +02:00
main_test.go Improvements (refactoring, test coverage) 2021-08-11 10:09:22 +02:00
templates.go Embed template files, new.css for forms and table 2021-08-11 15:07:28 +02:00
updateDeps.sh Update Go and dependencies 2023-04-27 17:05:25 +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, update 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.

Authentication

The preferred authentication method is Basic Authentication. If you try to create, modify or delete a short link, in the browser a popup will appear asking for username and password. Enter just the password you configured. Alternatively you can append a URL query parameter password with your configured password.

Usage

You can either create, update or delete short links using a browser by entering the short URL and the path for the method. Or you can make a HTTP POST request with the parameters.

  • Create a new short link: /s
    • url: URL to shorten
    • (optional) slug: the preferred slug
  • Update a short link: /u
    • slug: slug to update
    • new: new long URL
  • Delete a short link: /d
    • slug: slug to delete

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.