35dc5bf16f
|
||
|---|---|---|
| css | ||
| .gitignore | ||
| 404.php | ||
| README.md | ||
| admin-bar-partial.php | ||
| admin.php | ||
| blog_log.php | ||
| chickadee.svg | ||
| common.php | ||
| config.php | ||
| delete_data.php | ||
| edit.php | ||
| index.php | ||
| logcheck.php | ||
| logout.php | ||
| new-post.php | ||
| parsedown.php | ||
| pass_hash.php | ||
| post.php | ||
| rss_gen.php | ||
| site_actions.php | ||
| upload.php | ||
README.md
chickadee
A small php-based blog-system/cms that uses markdown (which also supports regular html markup) for post editing and a flat file system rather than a database. It is a single user system and, by design, does not support comments, social boost widgets, or other cruft. Just simple blogging and very basic media management. No javascript is used and there is no tracking.
Who is this for?
Likely just me and a few friends. That said, anyone wanting a simple and lightweight blog system for their website that just uses basic html and css with no javascript might enjoy it.
Current Capabilities
- Login (username/password)
- Login:
/blog.log.php
- Login:
- Admin area:
/admin.php- Post Actions
- Create (markdown is a first class citizen)
- Delete
- Edit
- Media Actions
- Upload images/documents
- Delete images/documents
- Site Actions
- Enable/Disable integrated simple.css css theme
- Editable custom css
- If simple.css is enabled, the css edit page will also show a guide for modifying the variables that simple.css has set up
- Post Actions
- Post Index (
index.php)- Shows list of posts
- Customizable top blurb
- Customizable bottom blurb
- Site header
- Site footer
- Individual Post
- Post body (rendered from markdown)
- Site header
- Site footer
- Behavioral Customization (
config.php)SITE_NAME, shown in site header and elsewhereTOP_BLURB, custom html that appears above post listing onindex.phpFOOT_BLURB, custom html that appears below post listing onindex.phpSITE_HEADER, custom html to override default site headerSITE_FOOTER, custom html to override default site footerSITE_LANG, language declaration for blog content (default isen)SHOW_DATES, turn on or off dates next to post titlesDATE_STYLE, php date format string for how dates should displaySIMPLE_CSS, turn on or off including of simple.css (can also be adjusted in the admin screen:/admin.php)INDEX_HEAD, injects additional tags at the end of the<head>element forindex.phpPOST_HEAD, injects additional tags at the end of the<head>element forpost.php
- RSS Feed
- Automatically creates a basic RSS feed and updates it whenever you make a new post (not an edit)
- Adds the feed as a
<link>to the head ofindex.php - Can be manually linked to using the path
/rssFeed.xmlin an anchor tag
Installation
chickadee requires php and a php capable web server (we use apache2, but whatever floats your boat and also runs php should be fine). There are no other requirements. chickadee is a flat file blog system and no database is required.
To install on your web server, go to where you want the blog installed and clone the repository as whatever you want the directory called. This may look something like the following:
cd /var/www/
git clone https://tildegit.org/sloum/chickadee myawesomeblog
cd myawesomeblog
vim config.php
Replace myawesomeblog with the name of your folder. This may be blog if integrating into an existing site, or may be the name of the website. While I use vim, use whatever you like to edit config.php. It is a well commented file and should direct you to some good defaults for your use case. Once you update it you may want to git add config.php && git commit "Updated config" so that you can still pull down updates of Chickadee if you want (without being hassled by notifications that you have uncommited changes).
Depending on your server setup, you may need to change the owner of the files. On Linux with Apache2 I do something like (from inside the repo dir root folder): sudo chown -R myuser:www-data .. That should make the files writable by the server.
Usage
Having installed, you need to set up your login information. This is easy, so long as your server is now exposing the paths and you can access the site: go to /blog_log.php. Enter a username and password of your choosing. Once you do so, you should see the admin area. The username and password you entered are now your username and password (the first ones entered are the ones used). If you ever need to reset your username/password you can go to the web root for the blog on your server and change the BLOG_HASH constant in pass_hash.php to null or false . This will reset the password without deleting any other data. You can then set a new one by going to the login page and entering new credentials.
Cookies are required to use the system, but only one cookie is ever set and no tracking or phoning home are done. When you log in the system will keep you logged in for 30 days unless you explicitly log out (or clear your cookies). If you aren't on your own machine and want to log in we recommend a private browsing window/tab that will clear the cookies automatically when closed.
Actual usage of the amin area is pretty self explanatory and mostly reflects the Admin Area part of Current Capabilities (above).