go-shrt

Shortlinks and go-get redirects
git clone git://git.danielmoch.com/go-shrt.git
Log | Files | Refs | README | LICENSE

README (970B)


      1 go-shrt
      2 ========
      3 
      4 This is a URL shortener. There are many like it, but this is mine. Try
      5 putting all the vowels in "shrt" and enjoy yourself!
      6 
      7 Also handles go-get redirects.
      8 
      9 There's no UI to add a new shortlink at this time. Just edit the DB by
     10 hand and kill -HUP the process.
     11 
     12 building
     13 --------
     14 
     15 $ make
     16 
     17 installation
     18 ------------
     19 
     20 # make install
     21 
     22 using
     23 -----
     24 
     25 Note that by default shrt expects its data files to be relative to the
     26 current directory.
     27 
     28 $ shrt -h
     29 usage: shrt [-hv] [-d dbpath] [-c cfgpath] [-l listenaddr] [init]
     30 $ shrt init
     31 server name: example.com
     32 SCM type: git # or hg, etc.. used for go-get redirects
     33 repo suffix (blank for none): .git # suffix to add to go-get repo URIs
     34 redirect base url: https://git.example.com
     35 bare redirect url: https://www.example.com
     36 $ shrt -l localhost:8080
     37 2020/12/06 12:57:01 listening on localhost:8080
     38 
     39 HTTPS is out-of-scope. Use a reverse-proxy with TLS termination.
     40 
     41 more documentation
     42 ------------------
     43 
     44 $ man 1 shrt