Rust webserver for embeddable comments
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Pascal Engélibert 5deba2fdb1
Api & JS client
5 months ago
client Api & JS client 5 months ago
locales feat: edit approval 5 months ago
src Api & JS client 5 months ago
templates feat: edit approval 5 months ago
.gitignore Initial commit 8 months ago
Cargo.lock Api & JS client 5 months ago
Cargo.toml Api & JS client 5 months ago
LICENSE Initial commit 8 months ago
README.md started implementing API 5 months ago
rustfmt.toml Initial commit 8 months ago

README.md

webcomment

Rust webserver for comments, that you can easily embed in a website.

Early development, not safe for production yet (see milestones)

Features

  • List and post comments by topic (e.g. each article in your blog is a topic)
  • Admin approval
  • Admin notification on new comment via Matrix
  • Embedded one-file webserver
  • Customizable Tera templates
  • Comment frequency limit per IP
  • i18n
  • Petnames! (anonymous comment authors get a funny random name)
  • Designed for privacy and moderation

Use

webcomment init

# This adds an admin password to the config (password are hashed)
webcomment psw

# edit ~/.config/webcomment/config.toml

webcomment start

Each topic is accessible at /t/<topic_name>.

Admin login is accessible at /admin. Once authenticated, you can see the pending comments on the topic pages.

Matrix

If enabled, a message can be sent to a Matrix room (private or public) on every new comment.

The account must have joined the room for Webcomment to be able to send messages to it.

Moderation

New comments are not public before being approved by the administrator (by default).

Privacy

Uses no cookie, no unique user identifier. At each mutation (i.e. new comment or edition), the client IP address is stored for a limited duration (configurable) only for antispam to work. (antispam can be disabled) The client IP address is also stored for each pending comment, but it is removed as soon as the comment gets approved.

However, keep in mind that if a reverse proxy (or any other intermediate tool) is used, IP addresses and other metadata may be logged somewhere.

API

/api/post_comment /api/comments_by_topic /api/edit_comment /api/remove_comment /api/get_comment /api/admin/approve_comment /api/admin/remove_comment

License

CopyLeft 2022-2023 Pascal Engélibert (why copyleft?)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.