waline-mini

English | 简体中文

A high-performance Waline comment system implemented in Rust.

Introduction

Waline-mini is a high-performance Rust implementation of the Waline comment system, using 95% less memory than its Node.js counterpart and serving as an efficient alternative for resource-constrained servers.

In my Ubuntu server, the waline-mini requires only about 5612Kb=5.48MB of memory.

• Extremely low memory usage: Just 1/25 of the Node.js version's memory footprint.
• Zero dependency deployment: No need to install Node.js environment, just an executable file is enough.
• Easy replacement: Implements most of the necessary apis of the original Waline.
• Synchronous update: Keeping pace with the original Waline's evolution.

Waline Feature Implementation

Feature	Availability	Status
Pageview Counter	Fully	Stable
Article Reactions	Fully	Stable
Comment Format Support	Fully	Stable
User Label	Fully	Stable
I18n Support	Fully	Stable
Email Notification	Nearly	In Progress
Security: XSS	Fully	Stable
Security: Frequency Limit	Fully	Stable
Security: Prevent flooding	Fully	Stable
Security: Comment Review	Fully	Stable
Security: Anti-spam comments	Fully	Stable
Security: Forbidden words	Fully	Stable
Security: Secure domains	Fully	Stable
Security: Disallow IP List	Fully	Stable
OAuth	Fully	Stable
Data migration	Fully	Stable
Two Factor Authentication	Fully	Stable

Usage

Run from an executable file

From GitHub Releases to download the binary file is appropriate for your platform. Examples of Linux use:

# Setting environment variables
export DATABASE_URL=sqlite:///path/to/waline.sqlite?mode=rwc
export JWT_TOKEN=your_secret_key
export SITE_NAME=your_site_name
export SITE_URL=your_site_url

# Start
./waline-mini

Confused about using SQLite? Jump to FAQ

Docker

services:
  waline:
    image: jqiue/waline-mini:latest
    container_name: waline-mini
    ports:
      - "8360:8360"
    volumes:
      - waline-db:/app/db
    environment:
      - DATABASE_URL=${DATABASE_URL:-sqlite:////app/db/waline.sqlite?mode=rwc}
      - JWT_TOKEN=${JWT_TOKEN}
      - SITE_NAME=${SITE_NAME}
      - SITE_URL=${SITE_URL}
    restart: unless-stopped

volumes:
  waline-db:
    driver: local

Shuttle

waline-mini supports deployment on Shuttle by first cloning the shuttle branch to the local using the following command

git clone -b shuttle https://github.com/JQiue/waline-mini.git

Then, create a .shuttle.env environment variable in the project root to configure waline-mini

Finally, in accordance with the Shuttle steps for deployment

LeanCloud

When LeanCloud is used to pull the warehouse directly for deployment, the branch needs to enter "leancloud".

If SQLite is used as the data store, the environment variable DATABASE_URL should be filled with sqlite://./waline.sqlite? mode=rw. When deploying with LeanCloud, a new SQLite file is included each time, so it is important to export the data before redeployment and import the data after redeployment when upgrading the waline-mini for redeployment.

Configuration

Configure waline-mini with environment variables:

Environment variable	Description	Require	Default
DATABASE_URL	Supports SQLite, MySQL/MariaDB, and PostgreSQL. protocol://username:password@host/database	✅	-
JWT_TOKEN	A random string is used to generate the JWT Signature key	✅	-
SITE_NAME	Site name	✅	-
SITE_URL	Site url	✅	-
SERVER_URL	Custom Waline server address		auto
HOST	listening host		127.0.0.1
PORT	listening port		8360
WORKERS	Worker thread		1
LEVELS	Give each user a rating label based on the number of comments		-
SMTP_SERVICE	SMTP mail service provider: QQ，GMail，126，163		-
SMTP_HOST	SMTP server address		-
SMTP_PORT	SMTP server port		-
SMTP_USER	SMTP username		-
SMTP_PASS	SMTP Password		-
AUTHOR_EMAIL	The blogger’s email, used to judge whether posted comment is posted by the blogger.If it is posted by the blogger, there will be no reminder notification		-
IPQPS	IP-based comment posting frequency limit in seconds. Set to 0 for no limit		60
COMMENT_AUDIT	Comment audit switcher. When enabled, every comment needs to be approved by admin, so hint in placeholder is recommended		false
AKISMET_KEY	Akismet antispam service key, set false if you wanna close it.		86fe49f5ea50
LOGIN	User need login before comment when LOGIN=force		false
FORBIDDEN_WORDS	If a comment match forbidden word, it will be marked as spam
DISALLOW_IP_LIST	If a comment ip match this list, 403 status code is returned. such as 8.8.8.8,3.3.3.3
SECURE_DOMAINS	Secure domain settings. Requests from other domain will receive 403 status code. It supports String, Regexp, and Array type. Leaving this config means that all domain referrer are allowed
DISABLE_AUTHORE_NOTIFY	wether disable author notification		false
DISABLE_REGION	wether hide commenter's region. Default value is false		false
DISABLE_USERAGENT	wether hide the user agent of commenter. Default value is false		false
IP2REGION_DB	customized IP query library path. The waline-mini does not contain xdb files and needs to be provided manually

FAQ

How to migrate data from the original Waline?

1. Export JSON from the original waline background administration page.
2. Import JSON on the waline-mini background administration page.

What databases are supported?

Currently supports SQLite, MySQL/MariaDB, and PostgreSQL.

Do I need to install SQLite package or start a service?

No! SQLite is an embedded database, and waline-mini has statically linked the SQLite driver (via Sea-ORM and sqlx). Just set DATABASE_URL=sqlite://./waline.sqlite?mode=rwc (where ./waline.sqlite is your data file path), and run ./waline-mini. The data file will be automatically created at the specified path, without needing to install or configure any additional services.

References

• waline-api