mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-16 01:26:07 +00:00
MHSanaei
9b91f0f42e
Fold the standalone 3x-ui-docs project (Next.js 16 + Fumadocs, deployed to docs.sanaei.dev) into docs/ so the panel and its documentation share a single source of truth, the way sing-box keeps its docs in-tree. The old repo becomes redundant and can be retired. - Import the full site under docs/ (app, components, content, lib, public, scripts, config). The self-contained pnpm project sits alongside the existing engineering notes with no filename collisions. - Re-point "Edit on GitHub" links from MHSanaei/3x-ui-docs to this repo's docs/content/docs path (docs/lib/shared.ts, docs/app/.../page.tsx). - Add docs-ci.yml and docs-deploy.yml under .github/workflows/, scoped to docs/** and run with working-directory: docs, since GitHub only runs workflows from the repo-root .github/. deploy-static.yml's GitHub Pages publish (CNAME docs.sanaei.dev) carries over unchanged. Follow-up (outside this commit): attach the docs.sanaei.dev custom domain to this repository's Pages (or set the Vercel project's root directory to docs), confirm the site is live from the monorepo, then delete MHSanaei/3x-ui-docs.
53 lines
1.3 KiB
Plaintext
53 lines
1.3 KiB
Plaintext
---
|
|
title: Migration
|
|
description: Migrate to 3x-ui from x-ui, between servers, or between 3x-ui versions.
|
|
icon: ArrowRightLeft
|
|
---
|
|
|
|
## Between servers
|
|
|
|
Moving to a new server is a database move:
|
|
|
|
<Steps>
|
|
|
|
<Step>
|
|
### Back up the old server
|
|
|
|
Copy the database (default `/etc/x-ui/x-ui.db`) and your certificates. See
|
|
[Backup & restore](/docs/operations/backup-restore).
|
|
</Step>
|
|
|
|
<Step>
|
|
### Install 3x-ui on the new server
|
|
|
|
Use the same install method and a compatible version. See
|
|
[Installation](/docs/guide/installation).
|
|
</Step>
|
|
|
|
<Step>
|
|
### Restore the database
|
|
|
|
Stop the panel, put the database in place, restore certificates, and start the
|
|
panel. Update any IP/domain-specific settings.
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Between 3x-ui versions
|
|
|
|
Within the same backend, upgrading is usually just re-running the installer or
|
|
pulling a new image — the panel migrates its own database. Across **major**
|
|
versions, read the [release notes](https://github.com/MHSanaei/3x-ui/releases)
|
|
first and take a backup.
|
|
|
|
## From x-ui
|
|
|
|
Importing an older x-ui panel's database directly into 3x-ui is **not
|
|
supported** — the schemas differ. Install 3x-ui fresh and recreate
|
|
inbounds/clients, exporting share links from the old panel as you go.
|
|
|
|
<Callout type="warn">
|
|
Always take a backup before any migration, and keep the old server running
|
|
until you've verified the new one.
|
|
</Callout>
|