3.0 KiB
SuchWowX
This service is a continuation of SuchWow for the Wownero cryptocurrency project. It has been revamped to use Interplanetary Filesystem, server federation / content sharing, and optionally Avalanche network via a smart contract with some useful features (if you're into that). It's a decentralized application (dApp); it's preferred you run it locally and bootstrap the services on your own machine.
Setup
Tools you will need:
- https://github.com/ava-labs/avalanchego/
- https://ipfs.io/#install
- python3 (linux os will have this)
- python3-venv
Development
I have provided a Makefile with some helpful stuff...make sure to install make to use it.
# install python virtual environment and install application dependencies
make setup
# install ipfs
sudo make install-ipfs
# optional: install avalanchego
make install-avax
# run ipfs
make run-ipfs
# optional: run avalanchego
make run-avax
# initialize sqlite database w/ schema via alembic
make init
# run development server
make dev
# access at http://127.0.0.1:5000
Production
You need a few more things:
- A VPS with a decent provider
- Nginx
- Certbot / Letsencrypt
Below is a set of commands you can follow to get setup. I used Ubuntu 20.04 on Digital Ocean. Run the below commands as root or prepend sudo.
# install nginx
apt-get install nginx -y
# install certbot
apt-get install certbot -y
# point DNS records at your VPS w/ a domain you control
# generate diffie hellman keys
openssl dhparam -out /etc/ssl/certs/dhparam.pem 2048
# setup nginx ssl config from this repo
cp conf/nginx-ssl.conf /etc/nginx/conf.d/ssl.conf
# setup nginx site config from this repo
cp conf/nginx-site.conf /etc/nginx/sites-enabled/suchwowx.conf
# generate TLS certificates
service nginx stop
certbot certonly --standalone -d <your dns record> --agree-tos -m <your email> -n
service nginx start
# setup ipfs service account and storage location
useradd -m ipfs
mkdir -p /opt/ipfs
chown ipfs:ipfs /opt/ipfs
# setup ipfs service daemon
cp conf/ipfs.service /etc/systemd/system/ipfs.service
systemctl daemon-reload
systemctl enable ipfs
systemctl start ipfs
# setup suchwowx service account and storage location
useradd -m suchwowx
mkdir -p /opt/suchwowx
# setup suchwowx application
git clone https://github.com/lalanza808/suchwowx /opt/suchwowx
cp /opt/suchwowx/env-example /opt/suchwowx/.env
vim /opt/suchwowx/.env
chown -R suchwowx:suchwowx /opt/suchwowx
# setup suchwowx service daemon
cp conf/suchwowx.service /etc/systemd/system/suchwowx.service
systemctl daemon-reload
systemctl enable suchwowx
systemctl start suchwowx
# setup ongoing syncing with remote servers and Avalanche network
crontab -u suchwowx conf/crontab
At this point you should have Nginx web server running with TLS certificates generated with Letsencrypt/Certbot, Systemd services for IPFS daemon for serving files and Gunicorn for serving the Flask application.
You'll obviously need to update some of your configuration files to match your domain/DNS, but it's fairly trivial.
Reach out on Twitter or Discord if you need support.