Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/SilverBlog/silverblog

A fast and lightweight blog framework based on Python3 development
https://github.com/SilverBlog/silverblog

blog-platform python3

Last synced: 3 months ago
JSON representation

A fast and lightweight blog framework based on Python3 development

Awesome Lists containing this project

README 

        
# SilverBlog



[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/SilverBlog/SilverBlog/blob/master/LICENSE)



[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FSilverBlogTeam%2Fsilverblog.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FSilverBlogTeam%2Fsilverblog?ref=badge_shield)



[中文版本](https://github.com/SilverBlog/silverblog/wiki/%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)



SilverBlog is a lightweight blog project based on Python3.



## Why SilverBlog



* Simple, compact blog system.

* Easy to install and deploy.

* Complete Rss support.

* Modular design, easy to add, delete.

* No database design.

* With a static page generation module comparable to Hexo, you can run on Github Page with only one line of commands.

* Native support for Linux can be deployed on any platform through Docker.

* Has Android, IOS, WEB client.

* Full [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/) support



## How to install

We support `freebsd`,`debian(ubuntu)`, `fedora`, `alpine`, `arch linux` for direct deployment. For other systems, please use Docker deployment.

You can install SilverBlog directly using the installation script:



```

bash -c "$(curl -fsSL https://get.silverblog.org/master/install/install.sh)"

```



Custom installation name:



```

bash -c "$(curl -fsSL https://get.silverblog.org/master/install/install.sh)" -n silverblog

```



Docker:



```

bash -c "$(curl -fsSL https://get.silverblog.org/master/install/docker_install.sh)"

```



If you are using a new install of Ubuntu 18.04, you may need to modify the `/etc/apt/source.list` file and add `universe` and `multiverse` software sources after `main`, which will ensure the installation will run smoothly. A correct configuration is as follows:



```

deb http://archive.ubuntu.com/ubuntu bionic main restricted universe multiverse



deb http://archive.ubuntu.com/ubuntu/ bionic-updates main restricted universe multiverse



deb http://archive.ubuntu.com/ubuntu/ bionic-backports main restricted universe multiverse



deb http://security.ubuntu.com/ubuntu bionic-security main restricted universe multiverse

```



You can select a theme in [silverblog-theme](https://github.com/silverblog-theme), then use `./manage.py` to install the configuration and configure it correctly in the configuration file below.



This installation script uses the nginx + uwsgi execution mode by default. You can put the auto-generated `nginx_config` file into your nginx package's website configuration directory. If you need to use a third-party web client, don't forget to modify the CORS configuration in `nginx_config`.



[wiki](https://github.com/SilverBlogTeam/silverblog/wiki)



## Start operation



You can run SilverBlog using tools such as Tmux or Screen. You just need to execute `python3 watch.py` to open your blog.



You can use the `--control` parameter to run the management server.



If you need to run blogs and manage servers simultaneously in a container, use the `python3 watch.py ​​--control --docker` command. We do not recommend this method of operation if conditions permit.



## Keep running and monitoring your blog



Containers started with docker-compose are automatically restarted. You just need to ensure that the Docker service starts automatically when it starts up.



You can configure your server using the `systemd_install.sh` file in the install directory, which requires root privileges. It is consistent with the recommended method below.



```

bash systemd_install.sh

```



custom:



```

bash systemd_install.sh -n silverblog -u silverblog

```



SilverBlog recommends using a NodeJS-based monitor: pm2



For the installation of pm2 see [tj/n: Node version management](https://github.com/tj/n) and [pm2 - Quick Start](http://pm2.keymetrics.io/docs/Usage/quick-start/)



you just have to run:



```

pm2 start pm2.json

```



It is possible to automatically restart SilverBlog after updating files or program errors.



You can also use:



```

pm2 startup

pm2 save

```



Enables your SilverBlog to start automatically when the system is powered on.



## How to use administrative scripts



You can use `./manage.py -h` at any time to get the help information for the SilverBlog management module.



Directly typing `./manage.py` will enter the whiptail build's graphical environment.



## Using the github page feature



You can use `git clone https://${personal_access_tokens}@github.com/${your_repo} static_page` to initialize your Github Page repository.



Don't forget to initialize your submit user information using the following command:



```

cd static_page

git config user.email "[email protected]"

git config user.name "your name"

```



Next, you just need to execute the Build static page command. The system will automatically generate a static page and submit it to the github page.



You can try using the `/example/.travis.yml` script for automated submission.



## Use client management server



Warning! If you need to use the SilverBlog client, make sure you use the https security protocol. Using http is like telling a password to a hacker! This may compromise your server security!



You can download the latest android client at https://github.com/SilverBlog/SilverBlog_Android/releases.



You can compile and deploy the https://github.com/SilverBlog/silverblog_ios IOS client yourself.



You can use SilverCreator (https://c.silverblog.org) to manage your blog.



You can execute `./manage.py qrcode` to generate the automated configuration QR code.



## Switch to developer preview



SilverBlog is now available as a developer preview version. You can switch from `git checkout --track -b origin/develop` to the developer preview in the repository root directory. This version may have undiscovered bugs. Please use it with caution.



## Participate in development



We welcome you to report issue or pull request on GitHub of the SilverBlog project.



If you are not yet familiar with GitHub's Fork and Pull development model, you can read the [GitHub Documentation](https://help.github.com/articles/using-pull-requests) for more information.



We recommend that you use the Chinese language to raise an issue, and attach an English translation below to make it easier for non-Chinese native language developers to read and understand.



## Thanks



Thanks to [@Liqueur Librazy](https://github.com/Librazy) for providing the demo program server for this project.



Thanks [Jetbrains](https://www.jetbrains.com/) for providing a free All product IDE for this project



## Give a cup of coffee and let me better maintain this project?



- [Support me in Paypal](https://paypal.me/nico_ranshi)



- Support me in Bitcoin (**17wmCCzy7hSSENnRBfUBMUSi7kdHYePrae**)



- [Support me in Cloud QuickPass](https://static.reallct.com/2019/02/21/5c6d812840bac.png)



Your donation will make me work better for this project.