# MixEngine

> A local web development environment: several PHP, Node, Python and Ruby versions at
> once, with the web server, databases and caches a project needs, real `.test` domains
> and automatic HTTPS — no Docker and no configuration written by hand.

Documentation for MixEngine 0.0.1. Every page below is plain Markdown at the URL
shown, and is the same file this project's repository holds. The HTML rendering of a page
is the same address without the `.md`.

## English

- [MixEngine](https://mixnz.github.io/mixengine/en/index.md): Run PHP, Node, Python and Ruby locally on any version, with real domains and HTTPS, without Docker.
- [Installing MixEngine](https://mixnz.github.io/mixengine/en/install.md): The installer for your system, what it touches, what it deliberately does not, and how to check what you downloaded.
- [Your first site](https://mixnz.github.io/mixengine/en/getting-started.md): From a fresh install to https://blog.test with a green padlock, in about five minutes.
- [Projects and sites](https://mixnz.github.io/mixengine/en/projects-and-sites.md): The two nouns MixEngine is built on, what each one owns, and how a checkout carries its own setup.
- [PHP, Node, Python and Ruby versions](https://mixnz.github.io/mixengine/en/runtimes.md): Install as many versions as you need, and let each directory choose its own — with no shell hook and nothing to remember.
- [Servers, databases and caches](https://mixnz.github.io/mixengine/en/services.md): Caddy or Nginx, MariaDB, MySQL, PostgreSQL, Redis and Memcached — installed on request, configured for you, and never printing a password.
- [Names and the padlock](https://mixnz.github.io/mixengine/en/domains-and-https.md): How blog.test reaches your machine, which certificate signed it, and how to find out when the padlock is not green.
- [Showing a site to your phone](https://mixnz.github.io/mixengine/en/sharing.md): Put one site on the local network, scan a QR code, and take it back off again — one site, one port, one rule.
- [Blueprints](https://mixnz.github.io/mixengine/en/blueprints.md): Write down what a project is made of, and set the same thing up again somewhere else — or on somebody else's machine.
- [Extensions](https://mixnz.github.io/mixengine/en/extensions.md): The tools you reach for beside the stack — phpMyAdmin, Mailpit, MinIO — installed from a signed registry, with what each one may do shown before you agree.
- [What MixEngine asks permission for](https://mixnz.github.io/mixengine/en/permissions.md): Every administrator prompt MixEngine can raise, what each one literally changes, and why nothing of MixEngine's ever stays running as root.
- [Keeping MixEngine current](https://mixnz.github.io/mixengine/en/updating.md): Updates are opt-in, checked against a signature, and rehearsed before anything is replaced — and one binary is deliberately never replaced this way.
- [Removing MixEngine](https://mixnz.github.io/mixengine/en/uninstalling.md): Undo everything MixEngine wrote outside its own directory, see the list before you agree, and keep your databases if you want them.
- [When something is wrong](https://mixnz.github.io/mixengine/en/troubleshooting.md): mix doctor first, then the four commands that answer the questions people actually have — and one file that holds everything a bug report needs.
- [Command reference](https://mixnz.github.io/mixengine/en/cli.md): Every mix command and every flag, generated from the binary's own definitions.
- [Reading this as a program](https://mixnz.github.io/mixengine/en/for-agents.md): Every page of this handbook is plain Markdown at a guessable address, with a manifest, a single-file bundle, and the same bytes inside the mix binary.

## Tiếng Việt

- [MixEngine](https://mixnz.github.io/mixengine/vi/index.md): Chạy PHP, Node, Python và Ruby ngay trên máy với đúng phiên bản bạn cần, có tên miền thật và HTTPS, không cần Docker.
- [Cài đặt MixEngine](https://mixnz.github.io/mixengine/vi/install.md): Bộ cài cho hệ điều hành của bạn, nó đụng vào những gì, cố ý không đụng vào những gì, và cách kiểm tra file vừa tải.
- [Site đầu tiên của bạn](https://mixnz.github.io/mixengine/vi/getting-started.md): Từ máy vừa cài xong tới https://blog.test với ổ khóa xanh, mất khoảng năm phút.
- [Dự án và site](https://mixnz.github.io/mixengine/vi/projects-and-sites.md): Hai khái niệm cốt lõi của MixEngine, mỗi cái quản những gì, và cách một bản checkout mang theo cấu hình của chính nó.
- [Phiên bản PHP, Node, Python và Ruby](https://mixnz.github.io/mixengine/vi/runtimes.md): Cài bao nhiêu phiên bản tùy bạn, và để mỗi thư mục tự chọn phiên bản của nó. Không hook shell, không phải nhớ gì cả.
- [Máy chủ, cơ sở dữ liệu và bộ nhớ đệm](https://mixnz.github.io/mixengine/vi/services.md): Caddy hoặc Nginx, MariaDB, MySQL, PostgreSQL, Redis và Memcached. Cài khi bạn yêu cầu, cấu hình sẵn cho bạn, và không bao giờ in mật khẩu ra màn hình.
- [Tên miền và ổ khóa](https://mixnz.github.io/mixengine/vi/domains-and-https.md): Vì sao blog.test trỏ về máy bạn, ai ký chứng chỉ cho nó, và cách tìm ra vấn đề khi ổ khóa không xanh.
- [Cho điện thoại xem site của bạn](https://mixnz.github.io/mixengine/vi/sharing.md): Đưa đúng một site ra mạng nội bộ, quét mã QR, rồi rút nó về. Một site, một cổng, một luật.
- [Blueprint](https://mixnz.github.io/mixengine/vi/blueprints.md): Ghi lại một dự án gồm những gì, rồi dựng lại y hệt ở nơi khác, hoặc trên máy của người khác.
- [Extension](https://mixnz.github.io/mixengine/vi/extensions.md): Những công cụ đi kèm stack như phpMyAdmin, Mailpit, MinIO. Cài từ một registry có chữ ký, và cho bạn xem mỗi cái được phép làm gì trước khi đồng ý.
- [MixEngine xin quyền để làm gì](https://mixnz.github.io/mixengine/vi/permissions.md): Mọi hộp thoại quyền quản trị mà MixEngine có thể hiện lên, mỗi cái thay đổi chính xác điều gì, và vì sao không có gì của MixEngine chạy thường trực với quyền root.
- [Giữ MixEngine luôn mới](https://mixnz.github.io/mixengine/vi/updating.md): Cập nhật do bạn quyết, có kiểm tra chữ ký, và có chạy thử trước khi thay bất cứ thứ gì. Riêng một chương trình cố ý không bao giờ được thay theo đường này.
- [Gỡ MixEngine](https://mixnz.github.io/mixengine/vi/uninstalling.md): Hoàn tác mọi thứ MixEngine đã ghi bên ngoài thư mục của nó, xem danh sách trước khi đồng ý, và giữ lại cơ sở dữ liệu nếu bạn muốn.
- [Khi có gì đó không ổn](https://mixnz.github.io/mixengine/vi/troubleshooting.md): Chạy mix doctor trước, rồi bốn lệnh trả lời đúng những câu hỏi người dùng hay gặp, và một file gom đủ mọi thứ một báo cáo lỗi cần.
- [Tham chiếu lệnh](https://mixnz.github.io/mixengine/vi/cli.md): Danh sách đầy đủ mọi lệnh mix, sinh tự động từ chính chương trình. Chỉ có bản tiếng Anh, và đây là lý do.
- [Đọc cẩm nang này bằng chương trình](https://mixnz.github.io/mixengine/vi/for-agents.md): Mọi trang của cẩm nang này đều là Markdown thuần tại một địa chỉ dễ đoán, kèm một manifest, một file gộp, và cùng nội dung đó nằm sẵn trong chương trình mix.

## Machine-readable

- [Page manifest](https://mixnz.github.io/mixengine/index.json): every page with its title, summary, both URLs and
the SHA-256 of its Markdown.
- [Every English page in one file](https://mixnz.github.io/mixengine/en/llms-full.txt)
- [Every Vietnamese page in one file](https://mixnz.github.io/mixengine/vi/llms-full.txt)
- [The daemon's API contract](https://github.com/mixnz/mixengine/tree/master/bindings):
TypeScript types for every request, response, event and error `mixengined` speaks.

The same pages are compiled into the `mix` binary: `mix docs <topic>` prints one with no
network and no running daemon, and `mix docs <topic> --json` wraps it in an object.