Propolis Wiki

A web3 wiki using the hive blockchain for storing articles.

Setup

Clone the project

  git clone https://github.com/pharesim/propolis-wiki

Go to the project directory

  cd propolis-wiki

edit config file

  cp instance/config_default.py instance/config.py
  nano instance/config.py

If you want the updater script to post to Discord, set DISCORD_WEBHOOK to a working link. Edits can also be announced to ecency.waves and/or leothreads, set the respective accounts in WAVES_ACCOUNT and/or LEOTHREADS_ACCOUNT to activate. The default hive interface for external hive links is https://hive.blog, you can change it by setting HIVE_INTERFACE

Database

Propolis requires a complementary PostgreSQL database to store some metadata. The structure can be derived from the updater.py script until there is a setup script/dump available.

Sync with Hive

The updater script will sync your database with the Hive blockchain

  python3 updater.py

Run Locally

Start the local flask dev server

  ./wiki.sh

Deployment

Install latest dist version including dependencies

  pip install dist/wiki*.whl

To deploy this project, you should use a webserver configured to your needs.

Example apache config:

DocumentRoot /var/www

WSGIDaemonProcess wiki user=wiki group=wiki threads=8
WSGIScriptAlias / /home/wiki/propolis-wiki/wsgi.py

<Directory /home/wiki/propolis-wiki>
    WSGIProcessGroup wiki
    WSGIApplicationGroup %{GLOBAL}
    Require all granted
</Directory>

Build

Create a new dist file

  ./build.sh

Don't forget to bump version in pyproject.toml and wiki/static/js/main.js

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

License

MIT