8000 GitHub - incidrthreat/goshorten
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

incidrthreat/goshorten

Repository files navigation

GoShorten

This project spawned due to my curiousity in gRPC, golang, and building something practical to share.


What is GoShorten?

GoShorten is a self-hosted URL Shortener written in Golang. It uses a gRPC server on the "backend" for API calls and stores data in a Redis Database. The current Time-To-Live for each URL/Code is possible via the webgui. Options for 5 min, 24 hrs, and 48 hrs are available.


Getting Started

Prerequisites

How to Run GoShorten:

  1. git clone https://github.com/incidrthreat/goshorten.git

  2. cd goshorten

  3. Execute ./generate-tls-certs.sh to generate the TLS certs.

  4. In the /backend directory, rename config.json.example to config.json

    1. Currently only supports Redis.
  5. docker-compose up or docker-compose up -d

    1. Redis "password" is on line 19 in docker-compose.yml
    2. Change password as necessary
  6. open your favorite browser to localhost:8081

Note: To view statistics of your code, append a + to the end of the uri.


Screenshots

Home Page

Home Page

Successful Code creation

Success!

Invalid Code retreival

Invalid

Statistics of generated code

Invalid


Contributing

If you are interested in contributing to this project please send an email to incidrthreat@hackmethod.com or submit a PR with any changes you'd like to see. If you run into issues please submit an issues "ticket" here.


Authors/Contributors

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0