A Python content management system designed for kirsle.net featuring a blog, comments and photo albums. https://rophako.kirsle.net/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.8 KiB

6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. # Rophako
  2. A simplistic content management system designed for
  3. [kirsle.net](http://www.kirsle.net/).
  4. Rophako is [Azulian](http://www.kirsle.net/wizards/translator.html) for
  5. "website." Pronounce it however you like. I pronounce it "roe-fa-koe."
  6. This project is under heavy construction.
  7. # Installation
  8. `pip install -r requirements.txt`
  9. These may need to be installed for the dependencies to build:
  10. **Fedora:** `libffi-devel libjpeg-devel libpng-devel`
  11. # Server Configuration
  12. Instructions and tips are currently available for the Apache web server.
  13. See [Apache.md](https://github.com/kirsle/rophako/blob/master/Apache.md) for
  14. information.
  15. Copy the file `config-sample.py` as a file named `config.py`, and edit
  16. its contents to set up your site. It's very important that you change the
  17. `SECRET_KEY` variable, as this is used to sign the session cookies and
  18. prevent people from tampering with them. The config script is well-documented
  19. with comments explaining what all the options do.
  20. # Create the Admin User
  21. Once the web app is up and running, navigate to the `/account/setup` URL
  22. to create the admin user account. Once the admin account has been created,
  23. the `/account/setup` path can't be used anymore. Additional user accounts
  24. can be created by the admin users at the `/admin` URL.
  25. # Building Your Site
  26. Rophako has a dual templating system. When the Rophako CMS wants to render
  27. a template (for example, `blog/entry.html`), it will look inside your
  28. `SITE_ROOT` path first for that template, before falling back to the default
  29. site templates inside the `rophako/www` path.
  30. All of the core features of Rophako (user account, blog, photo albums,
  31. comments, etc.) exist in the default site, so the CMS is already fully
  32. functional out-of-the-box. You can override files in the default site by
  33. putting files with the same name in your `SITE_ROOT` folder. For example,
  34. the default `SITE_ROOT` is set to the "site/www" folder in the git repo, and
  35. if you put a file at `site/www/layout.html` there, it will change the web
  36. design template for the Rophako site. A file at `site/www/index.html` will
  37. change the index page of your site away from the default.
  38. # Copyright
  39. Rophako CMS
  40. Copyright (C) 2014 Noah Petherbridge
  41. This program is free software; you can redistribute it and/or modify
  42. it under the terms of the GNU General Public License as published by
  43. the Free Software Foundation; either version 2 of the License, or
  44. (at your option) any later version.
  45. This program is distributed in the hope that it will be useful,
  46. but WITHOUT ANY WARRANTY; without even the implied warranty of
  47. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  48. GNU General Public License for more details.
  49. You should have received a copy of the GNU General Public License
  50. along with this program; if not, write to the Free Software
  51. Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA