simono41/snappass
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #57 from samueldg/fix/misc-docs

Browse source 
Various documentation fixes and improvements
This commit is contained in:
Nicholas Charriere 2017-04-16 10:39:42 -07:00 committed by GitHub
commit 431ab3b2e1
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
AUTHORS.rst
View file

@ -6,6 +6,7 @@ Credits
It is currently maintained by Nicholas Charriere and Yongwen Xu from Pinterest. It is currently maintained by Nicholas Charriere and Yongwen Xu from Pinterest.
Thanks a lot for the contributions of: Thanks a lot for the contributions of:
* Owen Coutts * Owen Coutts
* Ryan Park * Ryan Park
* Yongwen Xu * Yongwen Xu

11
README.rst
View file

@ -51,11 +51,13 @@ Configuration
You can configure the following via environment variables. You can configure the following via environment variables.
`SECRET_KEY` this should be a unique key that's used to sign key. This should `SECRET_KEY` this should be a unique key that's used to sign key. This should
be kept secret. See the `Flask Documentation`_ for more information. be kept secret. See the `Flask Documentation`__ for more information.
`DEBUG` to run Flask web werver in debug mode. See the `Flask Documentation`_ for more information. .. __: http://flask.pocoo.org/docs/quickstart/#sessions
.. _Flask Documentation: http://flask.pocoo.org/docs/quickstart/#sessions `DEBUG` to run Flask web server in debug mode. See the `Flask Documentation`__ for more information.
.. __: http://flask.pocoo.org/docs/quickstart/#debug-mode
`STATIC_URL` this should be the location of your static assets. You might not `STATIC_URL` this should be the location of your static assets. You might not
need to change this. need to change this.
@ -77,8 +79,9 @@ Alternatively, you can use `Docker`_ and `Docker Compose`_ to install and run Sn
.. _Docker: https://www.docker.com/ .. _Docker: https://www.docker.com/
.. _Docker Compose: https://docs.docker.com/compose/ .. _Docker Compose: https://docs.docker.com/compose/
:: ::
$ docker-compose up -d $ docker-compose up -d
This will pull all dependencies, i.e. Redis and appropriate Python version (3.6), then start up snappass and Redis server. SnapPass server is accessible at: http://localhost:5000 This will pull all dependencies, i.e. Redis and appropriate Python version (3.6), then start up SnapPass and Redis server. SnapPass server is accessible at: http://localhost:5000