LiteBlog is a blog system written in Golang,html,css,js. Aim to provide a simple, easy-to-use, highly customizable and lightweight blog system.

• Simple, Lightweight and easy-to-use interface
• Markdown and HTML support (with markedJS and highlightJS)
• own script and style injection support
• comment system support
• specialized full caching system for blog and asynchronous caching mechanism
• Auto block malicious request with firewall and XSS attack (with bluemonday)
• RSS Feed support
• Auto backup the configs and data
• Easy to deploy and manage
• Full static support

• Golang 1.24+

Clone the repository and run the following command to start the server.

• Before compile the binary, you should run following command to install the dependencies.

apt update && apt install -y wget git
wget https://go.dev/dl/go1.24.4.linux-amd64.tar.gz -O golang.tar.gz
tar -C /usr/local -xzf golang.tar.gz && rm -rf golang.tar.gz
export PATH=/usr/local/go/bin:$PATH

git clone https://github.com/LiteBlog/LiteBlog.git
cd LiteBlog
go run LiteBlog

Download the latest binary from release page and run it.Or you can build the binary from source.

• Before compile the binary, you should run following command to install the dependencies.

apt update && apt install -y wget git
wget https://go.dev/dl/go1.24.4.linux-amd64.tar.gz -O golang.tar.gz
tar -C /usr/local -xzf golang.tar.gz && rm -rf golang.tar.gz
export PATH=/usr/local/go/bin:$PATH

git clone https://github.com/LiteBlog/LiteBlog.git
cd LiteBlog
go build -o LiteBlog
./LiteBlog

Run ./build.sh to build the zip. Before build the zip, You should write your own configs in configs/ Here is a example to run liteblog with docker, and mount the configs directory to the container.You can use compress option to run build.sh, but you should install uglifyjs and uglifycss (using nodejs) first. If you want to change public or templates directory, you can mount it to the container using -v option.

• Before build the docker image, you should run following command to install the dependencies.

apt update && apt install -y git zip docker.io
wget https://go.dev/dl/go1.24.4.linux-amd64.tar.gz -O golang.tar.gz
tar -C /usr/local -xzf golang.tar.gz && rm -rf golang.tar.gz
export PATH=/usr/local/go/bin:$PATH

git clone https://github.com/LiteBlog/LiteBlog.git
cd LiteBlog
./build.sh platform linux/amd64 compress
docker build -t liteblog .
docker run -p 80:80 -v $(pwd)/configs:/liteblog/configs/ liteblog

• If you need to run the docker container in background, you can use -d option.

docker run -d -p 80:80 -v $(pwd)/configs:/liteblog/configs/ liteblog

This file contains the server configurations such as server port,TLS settings, cache settings, etc.

• backend_path: This is the path to the backend server.
• access_token: This is the access token for the backend server.
• RandomKey: If true, the server will generate token_encrypt_key randomly. If false, the server will use the backend_path and access_tokento generate the token_encrypt_key on each start up.

• use_disk: This is a boolean value to enable or disable the disk cache.
• max_cache_size: This is the maximum cache size in bytes.
• max_cache_items: This is the maximum number of cache items.
• expire_time: This is the expire time of the cache in seconds.

This is the deliver configuration. Impact the asynchronous cache mechanism.

• buffer: buffer size of the deliverer.
• threads: number of threads of the deliverer.

• backup_dir: This is the directory to store the backup files.
• backup_interval: This is the interval of the backup in seconds.
• max_backups: This is the maximum number of backup files to keep.
• max_backups_survival_time: This is the maximum survival time of the backup files in seconds.

This is the comment configuration.

• enabled: This is a boolean value to enable or disable the comment system.
• type: This is the comment system type. Currently only support cloudflare_turnstile.
• min_seconds_between_comments: This is the minimum seconds between two comments. Used to prevent spam.

This is the content advisor configuration. It may used to avoid the XSS attack.

• enabled: This is a boolean value to enable or disable the content advisor.
• filter_article: This is a boolean value to enable or disable the article filter. Affect the edit_article add_article api.
• filter_comment: This is a boolean value to enable or disable the comment filter. Affect the add_comment public api.
• filter_card: This is a boolean value to enable or disable the card filter. Affect the edit_card add_card api.

This is the notify configuration. It will send the notification to the target.

• enabled: This is a boolean value to enable or disable the notify system.
• type: This is the notify system type. Currently only support smtp telegrambot.
• trigger: This is the trigger of the notify system. Currently only support receive_comment.
• smtp_config: This is the smtp configuration. e.g.

{
    "host": "smtp.gmail.com:587",
    "username": "your_username",
    "password": "your_password",
    "from_addr": "your_email",
    "to_addrs": ["receiver1_email", "receiver2_email"]
}

• telegrambot_config: This is the telegrambot configuration. e.g.

{
    "token": "your_token",
    "chat_id": "your_chat_id"
}

This is the plugins configuration.

• enabled: This is a boolean value to enable or disable the plugins.

This is the sniffer configuration. It will sniff the request and response.

• enabled: This is a boolean value to enable or disable the sniffer.
• public_provider: Used to def the request url. If it is /sniffer, means you can use /api/v1/sniffer?path=/index.html to show the index page sniffer info.

This is the render configuration. It configures the render engine.

• render: A map to point out which need to be rendered.
• min_render_interval: The minimum seconds between render opration.
• max_render_interval: The maximum seconds between render opration.

This configs are used to customize the front-end.

This files are the articles data. Include the article title, content, comments, etc.

This file contains the cards data. It will impact the home page layout, rss feed layout, etc.

This file contains the firewall rules. It will block the malicious request.

When you in the index page, you can click the edit button or right click on the article title and select Edit Mode to enter the edit mode. In the edit mode, you can edit the card order, new cards, delete cards.

When you in the article page, you can right click the and select Edit Article to enter the edit mode. In the edit mode, you can edit the article title, content, author, etc.

When you in the index page, you can enter the edit mode and click the Add Article button on context menu to enter the add mode. In the add mode, you can add a new article.

When you in the article page, you can right click the and select Save Article to save the article file. You can edit it later.

The comment system is under development.

You can add your own script and style to the public/js/inject.js and public/css/customizestyle.css directory. The script and style will be injected to the page automatically.

You can add your own card template to the templates/your_card_template_name.html file. The card template will be used to display the cards on the home page.

The cache is used to improve the performance of the server. The cache will store the articles data and the rendered pages. When the server receive a request, it will check the cache first. If the cache hit, the server will return the cached data. If the cache miss, the server will render the page and store the data in the cache. The cache will be expired after the expire time.

The asynchronous cache mechanism is used to improve the performance of the server. When the resource can be cached, the server will use asynchronized deliver manager to deliver the content which need be cached. This can improve the performance of the server when need to cache a large amount of data.

Yes, Here is some example of the firewall rules, you should make sure the name is unique and the rule is correct.:

• if you want to block the ip address 8.9.10.11, you can add the following rule to the configs/firewall.json file:

{
    "//": "action 1: block, 0: allow/default",
    "name": "block_ipaddr_8.9.10.11",
    "action": 1,
    "type": "ipaddr",
    "rule": "8.9.10.11",
    "timeout": 99999999999
}

• if you want to block the ip cidr 192.168.0.0/24, you can add the following rule to the configs/firewall.json file:

{
    "//": "action 1: block, 0: allow/default",
    "name": "block_ipcidr_192.168.0.0/24",
    "action": 1,
    "type": "ipcidr",
    "rule": "192.168.0.0/24",
    "timeout": 99999999999
}

• if you want to block the user agent Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36, you can add the following rule to the configs/firewall.json file:

{
    "//": "action 1: block, 0: allow/default",
    "name": "block_useragent_default",
    "action": 1,
    "type": "useragent",
    "rule": "^Mozilla/5\\.0 \\(Windows NT 10\\.0; Win64; x64\\) AppleWebKit/537\\.36 \\(KHTML, like Gecko\\) Chrome/58\\.0\\.3029\\.110 Safari/537\\.36$",
    "timeout": 99999999999
}

• if you want to set rate limit rule, which will block the request if the request rate is over the limit, you can add the following rule to the configs/firewall.json file:

{
    "//": "rule: requests per second;args: block_time=60, block_time is the block time in seconds; cycle=10, the statistics cycle in seconds",
    "name": "default_rate_limit",
    "action": 1,
    "rule": "200",
    "type": "ratelimit",
    "timeout": 9999999999,
    "reason": "you have exceeded the rate limit",
    "args": [
        "block_time=60",
        "cycle=10"
    ]
}

• more Types are under development.

If you want to use it in full static mode, you can use -static flag to start the server. It will create a static/public directory and render all the pages to the directory. You can use nginx or other web server to serve the static files.

• this will use your configs to generate the static file. So before generate static file. Make sure your configs are made for static mode.

Unicode LiteBlog

MIT