|
1 | 1 |
|
2 |
| -**go-links** is a stand-along server that lets you set a keyword to get to an |
| 2 | +**go-links** is a stand-alone HTTP server that lets you set a keyword to get to an |
3 | 3 | URL. This is not a URL shortener which takes a URL that generates a shorter
|
4 | 4 | link, but lets you specify a short and easy-to-remember word to use so that if
|
5 | 5 | you type something like `go/hr` then it might direct you to your company's HR
|
@@ -35,20 +35,22 @@ The basics features of go-links are:
|
35 | 35 | URL.
|
36 | 36 | * When user uses an unknown keyword, they get directed to a form to create a new
|
37 | 37 | go link.
|
| 38 | +* Supports HTTPS. |
| 39 | +* Uses oAuth2 for user authentication (initially with Google accounts) |
| 40 | +* Support sessions. |
38 | 41 |
|
39 | 42 | Other features:
|
40 | 43 |
|
41 | 44 | * Simple deployment - go-links is a single binary.
|
42 |
| -* Uses oAuth2 for user authentication (initially with Google accounts) |
43 |
| -* Support sessions. |
44 | 45 | * Simple code so that people can easily modify it for their needs.
|
45 | 46 | * go-links is not meant to be library for building go link services.
|
46 | 47 | * Simple to build and compile - go-links is built using the Go programming
|
47 | 48 | langauge (no relations) and uses all native Go code.
|
48 | 49 |
|
49 |
| -NOTE: go-links is not meant for large enterprises with 100k users. I've not |
50 |
| -optimized for that scale. This is meant for my needs but thought it might be |
51 |
| -helpful for others so I wanted to make the code available. |
| 50 | +NOTE: go-links is not meant for large enterprises with thousands of users. This |
| 51 | +was a weekend project tailored for my needs but I did want to make it simple and |
| 52 | +easy to understand (and therefore easy to modify) for those looking for |
| 53 | +something similar. |
52 | 54 |
|
53 | 55 | ## Installation
|
54 | 56 |
|
@@ -87,12 +89,14 @@ will show the different parameters.
|
87 | 89 | ## Browser Extension
|
88 | 90 |
|
89 | 91 | I have a [simple browser
|
90 |
| -extension](https://github.com/lazyhacker/go-links-chrome-extension) to rewrite go/ to the go-link server if the |
91 |
| -machine's host settings can't be modified. |
| 92 | +extension](https://github.com/lazyhacker/go-links-chrome-extension) to rewrite |
| 93 | +go/ to the go-link server if the machine's host settings can't be modified. |
92 | 94 |
|
93 | 95 | ## TODO
|
94 | 96 |
|
95 | 97 | - memory cache
|
96 | 98 | - link transfer
|
97 | 99 | - refactor hard-coded strings
|
| 100 | +- have a HTTP middle-ware so channels can be shared instead of being a package |
| 101 | + variable. |
98 | 102 |
|
0 commit comments