README.md 1.2 KB
Newer Older
1
# Go (URL Shortener)
Jean Michel Rouly's avatar
Jean Michel Rouly committed
2 3 4

A project of [GMU SRCT](http://srct.gmu.edu).

5 6 7 8 9 10 11
Go is a drop-in URL shortening service. It aims to provide an easily
branded service for institutions that wish to widely disseminate
information without unnecessarily outsourcing branding.

## Configuration

### GoConfig
Jean Michel Rouly's avatar
Jean Michel Rouly committed
12

13 14
See `/wsgi/goconfig.py.template` for configuration variables. Relocate this
to `/wsgi/goconfig.py` when configured properly.
Jean Michel Rouly's avatar
Jean Michel Rouly committed
15

16 17 18 19
### Apache

The host or virtualhost being used for Go must have certain WSGIScriptAlias
directives.
Jean Michel Rouly's avatar
Jean Michel Rouly committed
20 21 22 23

```
WSGIScriptAlias /rd /srv/http/go/wsgi/redir.py
WSGIScriptAlias /index.html /srv/http/go/wsgi/index.py
24
WSGIScriptAlias /mylinks /srv/http/go/wsgi/mylinks.py
Jean Michel Rouly's avatar
Jean Michel Rouly committed
25 26 27 28 29
WSGIScriptAlias /login /srv/http/go/wsgi/login.py
WSGIScriptAlias /logout /srv/http/go/wsgi/logout.py
WSGIScriptAlias /signup /srv/http/go/wsgi/signup.py
WSGIScriptAlias /about /srv/http/go/wsgi/about.py
```
30 31 32 33 34 35

### Piwik

Piwik analytics are optionally enabled. See `/wsgi/goconfig.py.template`
for relevant configuration values. In order to use Piwik with this service,
you will need the
36 37 38 39 40 41 42
[Piwik Python API](https://github.com/piwik/piwik-python-api) installed.
Use one of the following for easy setup:

```
pip install piwikapi
pip2 install piwikapi
```