jlelse
/
GoShort
1
Fork 0
Code Packages Releases Activity
Minimal URL shortener
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 Commits
1 Branch
0 Tags
194 KiB
Go 95.2%
Shell 3.2%
Dockerfile 1.6%
 
 
 
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Go to file
Jan-Lukas Else 72599d467d
continuous-integration/drone/push Build is passing Details
Update dependencies 		4 months ago
templates Fix list 2 years ago
.drone.yml Upgrade dependencies, use Gitea container registry 8 months ago
.gitignore Some code improvements and updates 2 years ago
Dockerfile Update dependencies 4 months ago
LICENSE Initial commit 3 years ago
README.md Add HTML forms for actions 3 years ago
database.go Use another sqlite library without cgo 2 years ago
example-config.yaml Initial commit 3 years ago
go.mod Update dependencies 4 months ago
go.sum Update dependencies 4 months ago
main.go Use another sqlite library without cgo 2 years ago
main_test.go Improvements (refactoring, test coverage) 2 years ago
templates.go Embed template files, new.css for forms and table 2 years ago
updateDeps.sh Update dependencies 5 months ago

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.