~sirn/fanboi2: README.md

#Fanboi2

Board engine behind Fanboi Channel written in Python.

#Installation

For production environment, Fanboi2 has the following runtime requirements:

Additionally, the following packages are build-time requirements for compiling assets:

Node LTS
NPM

#Installing with Vagrant

If you're looking to develop or test Fanboi2, simply install Vagrant and run:

$ vagrant up

Then vagrant ssh and follow the Setting up applications section below.

#Installing on FreeBSD systems

On FreeBSD systems, these packages can be installed with:

$ sudo pkg install ca_root_nss python36 py36-sqlite3 py36-pip postgresql11-server postgresql11-client redis node12 npm-node12
$ pip install --user poetry

Setup PostgreSQL:

$ sudo sysrc postgresql_enable=YES
$ sudo service postgresql initdb
$ sudo service postgresql start
$ sudo -u postgres createuser $USER
$ sudo -u postgres createdb -O $USER fanboi2
$ sudo -u postgres createdb -O $USER fanboi2_dev
$ sudo -u postgres createdb -O $USER fanboi2_test

Setup Redis:

$ sudo sysrc redis_enable=YES
$ sudo service redis start

#Configuring environment variables

For convenient during development, configure these environment variables in .profile:

$ cat <<EOF >> ~/.profile
PATH=\$PATH:\$HOME/.local/bin; export PATH
CELERY_BROKER_URL=redis://127.0.0.1:6379/1; export CELERY_BROKER_URL
DATABASE_URL=postgresql://127.0.0.1:5432/fanboi2_dev; export DATABASE_URL
POSTGRESQL_TEST_DATABASE=postgresql://127.0.0.1:5432/fanboi2_test; export POSTGRESQL_TEST_DATABASE
REDIS_URL=redis://127.0.0.1:6379/0; export REDIS_URL
SERVER_DEV=true; export SERVER_DEV
SERVER_HOST=0.0.0.0; export SERVER_HOST
SERVER_PORT=6543; export SERVER_PORT
SESSION_SECRET=\$(openssl rand -hex 32); export SESSION_SECRET
AUTH_SECRET=\$(openssl rand -hex 32); export AUTH_SECRET
EOF

#Setting up application

After all packages are installed, setup the application with:

$ git clone https://git.sr.ht/~sirn/fanboi2 fanboi2
$ cd fanboi2/
$ poetry install --no-dev
$ npm install && npm run gulp

Then configure environment variables and run:

$ poetry run alembic upgrade head
$ poetry run fbctl serve

You also need to run the worker (each in its own terminal window) with:

$ poetry run fbcelery worker
$ poetry run fbcelery beat

And you're done! Please visit http://localhost:6543/admin/ to perform initial configuration.

#Configuring

Fanboi2 uses environment variable to configure the application. You may want to use something like Direnv to manage these environment variables.

AUTH_SECRET -- Required. Secret for authentication/authorization cookie.
CELERY_BROKER_URL -- Required. Redis URL for Celery broker, e.g. redis://127.0.0.1/1
DATABASE_URL -- Required. Database URL, e.g. postgres://127.0.0.1/fanboi2
REDIS_URL -- Required. Redis URL, e.g. redis://127.0.0.1/0
SESSION_SECRET -- Required. Secret for session cookie. Must not reuse AUTH_SECRET.
GEOIP_PATH -- Path to GeoIP database, e.g. /usr/share/geoip/GeoLite2-Country.mmdb
SERVER_DEV -- Boolean flag whether to enable dev console, default False
SERVER_SECURE -- Boolean flag whether to only authenticate via HTTPS, default False.

#Development

To setup Fanboi2 in development mode, run the following commands after performing production setup steps:

$ poetry install

And run the server with:

$ poetry run honcho start

#Submitting changes

To submit patches to mailing list:

Clone the repository: git clone https://git.sr.ht/~sirn/fanboi2
Make the necessary changes.
Configure Git sendmail address: git config sendemail.to ~sirn/fanboi2-dev@lists.sr.ht
Create a patch: git format-patch -1 HEAD (refer to git-format-patch(1) for more info)
Send a patch: git send-email -1 (refer to git-send-email(1) for more info)

To submit patches via GitHub Pull Request:

Fork the repository using "Fork" button on the top right of the GitHub project page.
Make the necessary changes.
Submit pull request against the master branch.

Submitting patches via mailing list is recommended in case you wish to remain anonymous (e.g. using thrown-away email address). GitHub, on the other hand, require you to create account with them and GitHub terms of service explicitly forbids having more than one account. Whether method you choose, our reviewer will review and merge the patch as soon as possible. It would be much appreciated if you could follow the following guidelines:

When making a non-trivial changes, please first discuss in the mailing list or in the development thread.
Make sure new features has enough tests and no regressions.

#License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.