Yet another blog system powered by Flask and MongoDB
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app optimize May 17, 2018
.env fix Jan 24, 2016
.gitignore export posts as json Feb 9, 2017
.travis.yml add Aug 31, 2017
LICENSE Initial commit Oct 9, 2015
README.md use alpine Apr 24, 2018
docker-compose.yml add docker swarm mode Apr 18, 2018
docker-compose_no_swarm.yml nginx serve static files Apr 24, 2018
requirements.txt confirm email May 15, 2018
requirements_test.py add test Aug 31, 2017

README.md

About OctBlog

Join the chat at https://gitter.im/flyhigher139/OctBlog Build Status

OctBlog is almost the same with MayBlog except that it is powered by Flask and MongoDB rather than Django and SQL Databases.

And as my customary, I named it OctBlog as OctBlog was started in October, 2015

OctBlog offers every function in MayBlog, and aims to do it better, its features are as follow:

  • Multiple user
  • OctBlog roles: su, admin, editor, writer, reader
  • Blog features: posts, pages, tags, and categories
  • Markdown support
  • Admin interface
  • Change configurations by configuration file or environment variable
  • Multiple comment plugin
  • User defined widgets
  • Deploy with docker
  • Sort posts by weight

Demo

Gevin's Blog is powered by OctBlog

Explanation

The weight is used to order articles, and if you want to hidden an article from the article list, weight is also qualified:

The default weight for each article is 10, if a article's weight is heavier than 10, it will be firstly displayed, and if the weight is negative, the article will be never displayed in the article list

Dependency

Backend

  • Flask
    • flask-script
    • flask-login
    • flask-admin
    • Flask-WTF
    • flask-principal
    • flask_mongoengine
  • WTForms
  • mongoengine
  • markdown2
  • bleach

Frontend

  • jQuery
  • BootStrap
  • Font Awesome
  • highlight.js

How to run OctBlog ?

Run from source code

If you want to see more about the source code, checkout the source code readme

Run by docker(recommended)

Run OctBlog by docker is recommended, here are some instruction:

First Run

1. Get your OctBlog image

In command line, switch to OctBlog root directory, and run the following command to build your own OctBlog image:

cd app
(sudo) docker build -t gevin/octblog:0.1 .

# Now you can take a cup of coffee and wait for a few minutes :)

Alternatively, pull Octblog image from DockerHub(recommended):

(sudo) docker pull gevin/octblog:0.1

2. Create your docker-compose.yml

You need to create a docker-compose file similar to the docker-compose_no_swarm.yml file

Replace /Users/gevin/projects/data/mongodb with a path on your machine

3. Run OctBlog

(sudo) docker-compose up -d

Then you can visit OctBlog in your brower at http://localhost

All environment variables can be found in /OctBlog/config.py

A .env file example:

DEBUG=false
config=prd
MONGO_HOST=mongo
allow_registration=true
allow_su_creation=true

name=Gevin's Blog
subtitle=技术、生活都要折腾
description=技术、生活都要折腾

wechat_name=GevinView @ <i class="fa fa-weixin" aria-hidden="true"></i>
wechat_subtitle=技术、生活都要折腾

copyright_msg=注:转载本文,请与Gevin联系
donation_msg=如果您觉得Gevin的文章有价值,就请Gevin喝杯茶吧!
wechat_msg=欢迎关注我的微信公众账号

google_site_verification=
allow_comment=true


allow_daovoice=true
daovoice_app_id=

3. Get into OctBlog container

Maybe you would like to dig into the container, the following command will help:

# Specify OctBlog container ID, eg:12345678
(sudo) docker ps

# Get into OctBlog container
(sudo) docker exec -it 12345678 bash

After first run

  • Start OctBlog
(sudo) docker-compose start
  • Stop OctBlog
(sudo) docker-compose stop

Run by docker with swarm mode

Preparation

If you want to use docker swarm mode, you need to activate this mode first:

docker swarm init

This command activates your docker swarm mode and make it as a swarm manager

Then you can join other swarm node to this manager with docker swarm join

Run OctBlog

You need to create a docker-compose file similar to the docker-compose.yml file.

Then, start your application:

docker stack deploy -c docker-compose.yml octblog

review your application:

docker stack ps octblog

remove your application:

docker stack rm octblog

You can refer to Docker Documentation for more docker swarm usages.

Get started with OctBlog

1. Create a superuser to administrate OctBlog

Visit the following url and create a superuser

http://localhost:8000/accounts/registration/su

If the url is forbidden, you need to modify your configurations to allow the creation.

2. Administrate OctBlog

The admin home is: http://localhost:8000/admin

You will be redirected to login page if you haven't logged in

3. Modify the default configurations

You either change settings in app/OctBlog/config.py file, or set environment variables defined in that file.

Setting environment variables is recommended, and once the configuration is changed, you need to restart the service.

License

OctBlog is under GPL2

What's more

If you find a bug or want to add a new feature, just issue me.

Want to contribute? Please fork OctBlog and pull request to me.

I'm not good at frontend development, so I used a free bootstrap blog theme. If you can redesign the blog theme and admin interface, I'll appriciate your work very much!