Skip to content

Latest commit

 

History

History
134 lines (103 loc) · 4.06 KB

INSTALL.md

File metadata and controls

134 lines (103 loc) · 4.06 KB
Raw

Installation

d-note is a Python Flask web application that requires a couple of libraries to be installed. I'll assume you're using Debian to install software. First, install python-flask and python-crypto:

# apt-get install python-flask python-crypto

Now make a directory under your web root to clone the Git repository:

# mkdir /var/www/
# git clone https://github.com/atoponce/d-note.git /var/www/dnote
# mkdir /var/www/dnote/data/
# chown root.www-data /var/www/dnote/data
# chmod g+w,o= root.www-data /var/www/data/dnote/data

Configuration

Make sure you change the configuration found in /var/www/dnote/dnote.py as necessary. The three salts listed in that configuration should be changed. You can run the following Python code to generate those salts:

>>> from Crypto import Random
>>> for salt in range(3):
...     print Random.new().read(16).encode('hex')

Apache Setup

Install libapache2-mod-wsgi to server the Python Flask web framework under Apache:

# apt-get install libapache2-mod-wsgi

Create a dnote.wsgi file under the web root:

# touch /var/www/dnote.wsgi

Add the following contents to that file:

#!/usr/bin/python
import sys
import logging
logging.basicConfig(stream=sys.stderr)
sys.path.insert(0,"/var/www/dnote/")
from dnote import DNOTE as application

Now configure Apache to server the application. Create /etc/apache2/site-available/ with the following contents. It's important that you serve the application over SSL. See additional Apache documentation as necessary.

<Virtualhost *:443>
    DocumentRoot /var/www/
    CustomLog /var/log/apache2/access.log combined
    ServerName www.example.com
    ServerAlias www.example.com example.com
    ServerAdmin webmaster@example.com
    <Directory /var/www/>
        Options -Indexes FollowSymLinks
    </Directory>
    WSGIScriptAlias / /var/www/dnote.wsgi
    <Directory /var/www/dnote/
        Order allow,deny
        Allow from all
    </Directory>
        Alias /d/static /var/www/dnote/static
    <Directory /var/www/dnote/static/>
        Order allow,deny
        Allow from all
    </Directory>

    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/www_example_com.crt
    SSLCertificateKeyFile /etc/ssl/private/www_example_com.key
    SSLHonorCipherOrder On
</VirtualHost>

Restart Apache, and verify that the site loads:

# service apache2 restart

Nginx Setup

Install uwsgi:

# apt-get install uwsgi uwsgi-core uwsgi-extra uwsgi-plugin-python

Create a uwsgi.ini file in the directory with the application:

# touch /var/www/dnote/dnote/uwsgi.ini

And add the following to that file (you can tweak these settings as required):

[uwsgi]
socket = /tmp/dnote.sock
chdir = /var/www/dnote
plugin = python
module = __init__:dnote
processes = 4
threads = 2
stats = 127.0.0.1:9192
uid = www-data
gid = www-data
logto = /var/log/dnote.log

You can now start the dnote application by running:

# /usr/bin/uwsgi -c /var/www/uwsgi.ini

You may want to add this to an init or upstart script, see: http://uwsgi-docs.readthedocs.org/en/latest/Management.html

Now lets configure nginx. A common example would be if you wanted it to be avaliable under http://yoursite.tld/dnote. To acheive this, add the following to your sites config (again, you can tweak thsi as needed):

location = /dnote { rewrite ^ /dnote/; }
location /dnote/ { try_files $uri @dnote; }
location @dnote {
    include uwsgi_params;
    uwsgi_param SCRIPT_NAME /dnote;
    uwsgi_modifier1 30;
    uwsgi_pass unix:/tmp/dnote.sock;
}

And tada, restart the Nginx server and you should have a working dnote setup.

Troubleshooting

If you are getting any internal service errors make sure to verify that the files in /var/www/dnote/dnote are readable by the webserver, and that /var/www/dnote/dnote/data/hashcash.db is writable as well.