<p align="center"> <img src="https://user-images.githubusercontent.com/22412567/171680920-6e74b77c-c565-487b-bff1-4f94976ecbe7.png" alt="Artalk" width="100%"> </p>

Artalk

Homepage • Documentation • Latest Release • Changelog • 简体中文

Artalk is an intuitive yet feature-rich comment system, ready for immediate deployment into any blog, website, or web application.

• 🍃 Client ~40KB, crafted with pure Vanilla JS, framework-agnostic
• 🍱 Server powered by Golang, offering efficient and lightweight cross-platform performance
• 🐳 One-click deployment via Docker, ensuring ease and speed
• 🌈 Open-source software, self-hosted with privacy as a priority

Features

<!-- prettier-ignore-start --> <!-- features -->

• Sidebar: Quick management, intuitive browsing
• Social Login: Fast login via social accounts
• Email Notification: Various sending methods, email templates
• Diverse Push: Multiple push methods, notification templates
• Site Notification: Red dot marks, mention list
• Captcha: Various verification types, frequency limits
• Comment Moderation: Content detection, spam interception
• Image Upload: Custom upload, supports image hosting
• Markdown: Supports Markdown syntax
• Emoji Pack: Compatible with OwO, quick integration
• Multi-Site: Site isolation, centralized management
• Admin: Password verification, badge identification
• Page Management: Quick view, one-click title navigation
• Page View Statistics: Easily track page views
• Hierarchical Structure: Nested paginated list, infinite scroll
• Comment Voting: Upvote or downvote comments
• Comment Sorting: Various sorting options, freely selectable
• Comment Search: Quick comment content search
• Comment Pinning: Pin important messages
• View Author Only: Show only the author's comments
• Comment Jump: Quickly jump to quoted comment
• Auto Save: Content loss prevention
• IP Region: Display user's IP region
• Data Migration: Free migration, quick backup
• Image Lightbox: Quick integration of image lightbox
• Image Lazy Load: Lazy load images, optimize experience
• Latex: Integrate Latex formula parsing
• Night Mode: Switch to night mode
• Extension Plugin: Create more possibilities
• Multi-Language: Switch between multiple languages
• Command Line: Command line operation management
• API Documentation: Provides OpenAPI format documentation
• Program Upgrade: Version check, one-click upgrade

<!-- /features --> <!-- prettier-ignore-end -->

Installation

Deploy Artalk Server with Docker in one step:

docker run -d \
    --name artalk \
    -p 8080:23366 \
    -v $(pwd)/data:/data \
    -e "TZ=America/New_York" \
    -e "ATK_LOCALE=en" \
    -e "ATK_SITE_DEFAULT=Artalk Blog" \
    -e "ATK_SITE_URL=https://example.com" \
    artalk/artalk-go

Integrate Artalk Client into your webpage:

<!-- prettier-ignore-start -->

Artalk.init({
  el:      '#Comments',
  site:    'Artalk Blog',
  server:  'https://artalk.example.com',
  pageKey: '/2018/10/02/hello-world.html'
})

<!-- prettier-ignore-end -->

We offer various installation methods, including binary files, go install, and package managers for Linux distributions.

Learn More →

For Developers

Pull requests are welcome!

See Development and Contributing for information on working with the codebase, getting a local development setup, and contributing changes.

Contributors

Your contributions enrich the open-source community, fostering learning, inspiration, and innovation. We deeply value your involvement. Thank you for being a vital part of our community! 🥰

Supporters

Repobeats Analytics

Stargazers over time

<a href="https://trendshift.io/repositories/6290" target="_blank"><img src="https://trendshift.io/api/badge/repositories/6290" alt="ArtalkJS%2FArtalk | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>

License

MIT