Basic instructions for setting up a TileHuria server using Flask.
A lot of this is fairly directly taken from the DigitalOcean community tutorial https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-uswgi-and-nginx-on-ubuntu-18-04.
Create a cloud server (Ubuntu 20.04) and a sudo user. The usual setup from https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-20-04. Log in.
You'll need a domain name for the ssl encryption to work. Get one somewhere (I use Namecheap, though I don't have any reason to believe it's any better than any other, it's literally just the first registrar I got an account with). Instructions for setting that up can be found here.
git clone --recurse-submodules https://github.com/HumanitarianStuff/tilehuria-flask
cd tilehuria-flask/
In the script directory, there is a setup script that, if everything is perfect, will install the Tilehuria web app.
sudo script/setup.sh
The script will ask you your domain name (you need one of those, as mentioned above) and your email (for messages from LetsEncrypt about your ssl certificates). Then it'll (maybe) set up the server for you automagically.
You will still need to add URLs for the tileservers you wish to use; we cannot legally provide them as we don't know if you're planning to violate the terms of service of the tile service providers!
If that didn't work (shocker), here are the steps to install.
sudo apt install -y python3-venv
sudo apt install -y python3-dev
python3 -m venv venv
source venv/bin/activate
pip install wheel
pip install flask
pip install uwsgi
Discussion of this task, which seems way more complicated than it should be, can be found here (where I found a way to accomplish it): https://stackoverflow.com/questions/32066828/install-gdal-in-virtualenvwrapper-environment first the gdal library itself:
sudo apt install libgdal-dev
Then the pygdal hooks:
gdalversion=$(gdal-config --version)
pip install pygdal==$gdalversion
That'll probably give you an error, so you look at the error output and add the latest version (i.e. pip install pygdal==2.2.3.3). Or replace the previous block with the following (unfinished block):
source venv/bin/activate
gdalversion=$(gdal-config --version)
ERROR=((pip install pygdal==$gdalversion) 2>&1)
echo $ERROR
# now find the largest matching number in the string contained in the ERROR variable. Stick it in variable newgdalversion and use it in a repeat command
pip install pygdal==$newgdalversion
At time of writing that produces pip install pygdal==3.0.4.6.
pip install pillow
pip install Flask-SQLAlchemy
I dunno. At some point I'll try without doing this, but haven't gotten around to it and no idea what will happen without it.
pip install python-dotenv
If you want to confirm that things are working thus far, you can run the Flask development server and connect to it from your browser at tilehuria.org:5000 (or whatever your actual URL is). To run the server type:
flask run --host=0.0.0.0
and control-C to stop it.
You can also try it using the uWSGI server running from the command line. This assumes that the various bits of setup are correctly configured; the Github may have some hard-coded stuff in the Flask-related files specific to the tilehuria.org URL.
The uWSGI server is really useful because there isn't any logging, error checking, or anything working yet. When running as a service, there's no obvious way to troubleshoot. On the uWSGI server, you'll see command line output including error message.
uwsgi --socket 0.0.0.0:5000 --protocol=http -w wsgi:app
Again, try connecting to it from your browser, and when done testing control-C to stop it.
bung the following into /etc/systemd/system/tilehuriaflask.service (this file is actually provided in the repo, so you can just copy it over sudo cp tilehuriaflask.service /etc/systemd/system/
[Unit]
Description=uWSGI instance to serve tilehuriaflask
After=network.target
[Service]
User=tilehuria
Group=www-data
WorkingDirectory=/home/tilehuria/tilehuria-flask
Environment="PATH=/home/tilehuria/tilehuria-flask/venv/bin"
ExecStart=/home/tilehuria/tilehuria-flask/venv/bin/uwsgi --ini tilehuriaflask.ini
[Install]
WantedBy=multi-user.target
Now start and enable the service by:
sudo systemctl start tilehuriaflask.service
sudo systemctl enable tilehuriaflask.service
If you want to test that this worked, enter sudo systemctl status tilehuriaflask.service
sudo apt install nginx
Enter the following into /etc/nginx/sites-available/tilehuriaflask (again, file provided, just sudo cp tilehuriaflask /etc/sites-available/:
server {
listen 80;
server_name tilehuria.org www.tilehuria.org;
location / {
include uwsgi_params;
uwsgi_pass unix:/home/tilehuria/tilehuria-flask/tilehuriaflask.sock;
}
}
and symlink it to the sites-enabled by typingsudo ln -s /etc/nginx/sites-available/tilehuriaflask /etc/nginx/sites-enabled
sudo apt install certbot python3-certbot-nginx
sudo certbot --nginx -d tilehuria.org -d www.tilehuria.org
It should work now.