README 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. # freepost
  2. This is the code powering [freepost](https://freepo.st), a free
  3. discussion board that allows users to post text and links that other
  4. users can read and comment.
  5. # Development
  6. ## Setup Python3 virtual environment
  7. cd freepost-directory
  8. python3 -m venv venv (if this doesn't work, try `virtualenv -p /usr/bin/python3 venv`)
  9. source venv/bin/activate
  10. pip3 install -r requirements.txt
  11. ## Run test server
  12. source venv/bin/activate
  13. python3 -m bottle --debug --reload --bind 127.0.0.1:8000 freepost
  14. # Deployment
  15. - Copy all files to your `public_html` folder
  16. - Rename `.htaccess.wsgi` or `.htaccess.cgi` to `.htaccess` (if you use CGI or WSGI)
  17. - Change settings in `settings.yaml` if needed
  18. - Create Python virtual environment
  19. For tuxfamily only: run `newgrp freepost` before creating the virtenv, for quota reasons
  20. - Create a new empty SQLite database: `cat database.schema.sql | sqlite3 database.sqlite`
  21. - Make sure `settings.yaml` has restricted permissions, for instance `0600`.
  22. If the SQLite database is located in the same HTML folder, make sure this too has
  23. restricted access
  24. Everything should be setup and working. Make sure your CGI or WSGI server is
  25. configured correctly.
  26. ## License
  27. freepost is [free software](https://www.gnu.org/philosophy/free-sw.html) licensed
  28. as GNU Affero General Public License, either version 3 or (at your option) any
  29. later version.
  30. `monkey` logo art by iko, released as CC0.