ShareX
/
golang-url-shortener
mirror of https://github.com/mxschmitt/golang-url-shortener.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
golang-url-shortener/README.md

51 lines
2.6 KiB
Markdown
Raw Permalink Normal View History

readme: removed wip
2018-07-29 12:03:19 +00:00
# Golang URL Shortener
Initial commit
2017-10-29 19:38:19 +00:00
Readme: Username adapted after name change
2018-02-02 07:58:12 +00:00
[![Build Status](https://travis-ci.org/mxschmitt/golang-url-shortener.svg?branch=master)](https://travis-ci.org/mxschmitt/golang-url-shortener)
[![GoDoc](https://godoc.org/github.com/mxschmitt/golang-url-shortener?status.svg)](https://godoc.org/github.com/mxschmitt/golang-url-shortener)
[![Go Report Card](https://goreportcard.com/badge/github.com/mxschmitt/golang-url-shortener)](https://goreportcard.com/report/github.com/mxschmitt/golang-url-shortener)
[![Coverage Status](https://coveralls.io/repos/github/mxschmitt/golang-url-shortener/badge.svg?branch=master)](https://coveralls.io/github/mxschmitt/golang-url-shortener?branch=master)
- Removing sourcemaps bevore we embed it - removed Service worker - removed unnecessary run.sh (now we have a Makefile) - Cleaned up README.md
2017-11-08 15:52:37 +00:00
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
Fixed bintray deployment (fix: #110)
2018-05-25 20:26:40 +00:00
[![Download](https://api.bintray.com/packages/mxschmitt/golang-url-shortener/travis-ci/images/download.svg?version=0.1) ](https://bintray.com/mxschmitt/golang-url-shortener/travis-ci/0.1#files)
Changed maxibanki to new mxschmitt username
2018-02-05 13:04:47 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/mxschmitt/golang_url_shortener.svg)](https://hub.docker.com/r/mxschmitt/golang_url_shortener/)
Replaced wafflel.ui badge
2017-11-03 10:45:16 +00:00
- Added schema generation for the configuration - added example configuration - changed ID Length to uint instead of int - Added ShareX configuration generation in the frontend
2017-11-06 21:02:22 +00:00
## Main Features
Initial commit
2017-10-29 19:38:19 +00:00
Updated badges and added travisci file
2017-10-29 23:05:56 +00:00
- URL Shortening
- Visitor Counting
fixed broken CI build
2017-11-09 08:44:20 +00:00
- Expirable Links
- Added schema generation for the configuration - added example configuration - changed ID Length to uint instead of int - Added ShareX configuration generation in the frontend
2017-11-06 21:02:22 +00:00
- URL deletion
support using an identity-aware proxy for auth (#101) Rather than directly fetching and verifying OAuth assertions, assume that the app is running behind an authenticating proxy, and trust headers that are set by the proxy. - add config support for an "authbackend" directive, supporting either "oauth" or "proxy" as values; the "proxy" setting selects our new codepath - add initProxyAuth and proxyAuthMiddleware methods to the Handler struct - rename authMiddleWare to oAuthMiddleware in the Handler struct - construct a faked auth.JWTClaims object when in proxy mode - update Handler.handleAuthCheck() to return useful info in proxy mode - add a fallback user icon for proxy mode - implement check for proxy mode in index.js See for example and reference: https://cloud.google.com/iap/docs/identity-howto https://cloud.google.com/beyondcorp/
2018-05-08 18:34:32 +00:00
- Multiple authorization strategies:
Okta Integration - Bring Okta OAuth as an available option (#128) - Edited package.json for react bug + https://github.com/ReactTraining/react-router/issues/6630
2019-03-20 07:28:01 +00:00
- Local authorization via OAuth 2.0 (Google, GitHub, Microsoft, and Okta)
support using an identity-aware proxy for auth (#101) Rather than directly fetching and verifying OAuth assertions, assume that the app is running behind an authenticating proxy, and trust headers that are set by the proxy. - add config support for an "authbackend" directive, supporting either "oauth" or "proxy" as values; the "proxy" setting selects our new codepath - add initProxyAuth and proxyAuthMiddleware methods to the Handler struct - rename authMiddleWare to oAuthMiddleware in the Handler struct - construct a faked auth.JWTClaims object when in proxy mode - update Handler.handleAuthCheck() to return useful info in proxy mode - add a fallback user icon for proxy mode - implement check for proxy mode in index.js See for example and reference: https://cloud.google.com/iap/docs/identity-howto https://cloud.google.com/beyondcorp/
2018-05-08 18:34:32 +00:00
- Proxy authorization for running behind e.g. [Google IAP](https://cloud.google.com/iap/)
- Removing sourcemaps bevore we embed it - removed Service worker - removed unnecessary run.sh (now we have a Makefile) - Cleaned up README.md
2017-11-08 15:52:37 +00:00
- Easy [ShareX](https://github.com/ShareX/ShareX) integration
- Dockerizable
Added redis support (#100) - add a redis store implementing stores.Storage - add config file support to pick a storage backend - add config file support to set redis host:port and password - add docker_releases to .gitignore - update README to mention redis support - update example config.yaml
2018-05-07 20:48:37 +00:00
- Multiple supported storage backends
- High performance local database with [bolt](https://github.com/boltdb/bolt)
- Persistent non-local storage with [redis](https://redis.io/)
Initial commit
2017-10-29 19:38:19 +00:00
Small bugfixes
2017-11-28 18:45:43 +00:00
## [Webinterface](https://so.sh0rt.cat)
Fix #32
2017-11-12 15:18:17 +00:00
![Short URLs](https://user-images.githubusercontent.com/17984549/32700384-955d9336-c7c4-11e7-9fab-4141a86a375c.png)
---
![Generate ShareX Configuration](https://user-images.githubusercontent.com/17984549/32700395-cf9f057a-c7c4-11e7-9d2b-7523c8a95a20.png)
Fix typo in readme
2018-11-01 23:38:47 +00:00
## Documentation
Initial commit
2017-10-29 19:38:19 +00:00
Readme: Username adapted after name change
2018-02-02 07:58:12 +00:00
- [Installation](https://github.com/mxschmitt/golang-url-shortener/wiki/Installation)
- [Configuration](https://github.com/mxschmitt/golang-url-shortener/wiki/Configuration)
- [Setting up OAuth](https://github.com/mxschmitt/golang-url-shortener/wiki/Setting-up-OAuth)
- [ShareX Usage](https://github.com/mxschmitt/golang-url-shortener/wiki/ShareX)
- Removed that the IP of the creator will be shown in the info request - improved README.md
2017-10-29 22:49:36 +00:00
- Added schema generation for the configuration - added example configuration - changed ID Length to uint instead of int - Added ShareX configuration generation in the frontend
2017-11-06 21:02:22 +00:00
## Why did you built this
Minor changes: - Switched the config to JSON - Added Frontend - Added fist oAuth parts
2017-11-01 17:00:28 +00:00
Cleaned up code and integrated deletion handling: fix #10
2017-11-21 20:35:45 +00:00
Only because I just want to extend my current self hosted URL shorter (which was really messy code) with some more features and learn about new techniques like:
- Removing sourcemaps bevore we embed it - removed Service worker - removed unnecessary run.sh (now we have a Makefile) - Cleaned up README.md
2017-11-08 15:52:37 +00:00
Fix #7
2017-11-09 08:30:15 +00:00
- Golang unit testing
- Removing sourcemaps bevore we embed it - removed Service worker - removed unnecessary run.sh (now we have a Makefile) - Cleaned up README.md
2017-11-08 15:52:37 +00:00
- React
- Makefiles
- Travis CI
Fix #7
2017-11-09 08:30:15 +00:00
- Key / Value databases
- Improved responsiveness and added s.b0n.pl as an hosted demo in the README.md
2017-11-19 17:42:07 +00:00
- Dockerfile and Docker Image Creation