Open-source project
remnawave/panel avatar
remnawave/panel

Remnawave panel: the repository holds docs, not the panel

A powerful proxy management tool, built on top of Xray-core, with a focus on simplicity and ease of use.

5,361 stars314 forksTypeScriptAGPL-3.0

At a glance

What is it?
Remnawave is a TypeScript proxy management tool sitting on Xray-core, but this GitHub repository is the Docusaurus documentation site plus a Caddy image for it. Install steps, runtime dependencies and the panel's feature surface live at docs.rw, not in the tree.
Who is it for?
Remnawave suits operators who already run Xray-core and want a control plane in front of it, but judge it from docs.rw and the release assets, because this repository will not get you to a running panel. Before deploying, confirm what the panel binary itself needs at runtime, since the manifest and Dockerfile here describe a Node 22 documentation site and a Caddy static server.
Can I use it commercially?
Yes, with strict conditions. AGPL-3.0 is a network copyleft licence: if people use a modified version over a network, for example as a hosted service, you must offer them its source code under the same licence.
Is it still maintained?
Yes. The repository last received commits 2 days ago.
What is it written in?
Mainly TypeScript, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • remnawave/panel5,361 ★ · +255
Star history
Repository2026-09-232026-11-15
remnawave/panel5.1k5.4k

255 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The README is a row of anchors and one sentence of prose

Almost everything in the README is HTML. The only prose is a single line describing Remnawave as a proxy management tool built on top of Xray-core with a focus on simplicity and ease of use, wrapped in anchors that point at docs.rw, the releases page, the stargazers list and a Telegram channel. There is no prerequisite list, no install command, no compose file, no environment variable table and no configuration sample anywhere in it. Clone the repository expecting a service and you get a documentation project. The practical consequence is that every answer about installation, node configuration and panel behaviour has to be fetched from docs.rw or read out of the release assets, so the repository alone cannot tell you whether a given deployment is set up correctly.

package.json describes the docs site, not the panel server

The root manifest is named `@remnawave/docs`, pinned at version 0.0.1 and marked private, so publishing to a registry is not the distribution path for anything here. Every script belongs to Docusaurus: `docusaurus start` for local work, `NODE_ENV=production docusaurus build` for the static output, alongside `swizzle`, `deploy`, `clear`, `serve`, `write-translations` and `write-heading-ids`. Dependencies are React 19.2.0, `@docusaurus/core` and `@docusaurus/preset-classic` at ^3.9.2, the client redirects plugin, the Mermaid theme, `@scalar/docusaurus` for API reference rendering, `@tabler/icons-react`, clsx, prism-react-renderer and react-icons. Node is floored at:

json
  "engines": {
    "node": ">=22.0"
  }

That floor governs the documentation build. No server framework, database driver or Xray client library appears in this file, so the panel's own dependency set cannot be recovered from the repository.

The Dockerfile serves static files through Caddy

The only container definition here publishes a website, not a control plane:

dockerfile
ARG CADDY_VERSION=2.10
ARG IMAGE_NAME=remnawave-docs

FROM caddy:${CADDY_VERSION}-alpine

LABEL name=${IMAGE_NAME}

WORKDIR /app

COPY build /app/docs
COPY landing /app/landing

COPY Caddyfile /etc/caddy/Caddyfile

EXPOSE ${PORT:-80}

CMD ["caddy", "run", "--config", "/etc/caddy/Caddyfile", "--adapter", "caddyfile"]

Three things follow from it. The image name argument is `remnawave-docs`, and nothing in it carries panel code, so starting it gives you documentation. `EXPOSE` records a port instead of publishing one, so your host mapping has to agree with whatever `PORT` resolves to at runtime. And all routing rules live in the root `Caddyfile`, which is the file to read before putting a reverse proxy in front of the site.

Two documentation trees sit next to each other

The top level holds `docs/` and `_panel-docs/` as markdown sources, plus `static/` for assets, `docusaurus.config.ts` for site configuration and `sidebars.ts` for the sidebar tree. Which of the two directories feeds the published site is not stated anywhere in the repository, and `sidebars.ts` is the file that would settle it, so a first local run is guesswork until you read it. The two commands that matter for a local preview are the same ones the build uses:

json
    "start": "docusaurus start",
    "build": "NODE_ENV=production docusaurus build",

`build` sets `NODE_ENV=production` itself, so no separate environment flag is needed before serving the output with the `serve` script.

Linting and formatting run on oxlint and oxfmt

The toolchain has moved off the older defaults, and the config files follow it: `.oxlintrc.json` and `.oxfmtrc.json` sit at the root where `.eslintrc` and `.prettierrc` are usually expected. The combined gate is one script:

json
    "check": "oxfmt --check && oxlint",

`format` runs `oxfmt --check`, `format:fix` runs `oxfmt`, `lint` runs `oxlint --format=stylish` and `lint:fix` runs `oxlint --fix`. Styling runs through PostCSS with `postcss-preset-mantine` and `postcss-simple-vars`, and TypeScript sits at ~5.8.3 with `typecheck` mapped to `tsc`. All of it is type and style tooling for a documentation project, and none of it lints the panel.

Three patch tags shipped inside two weeks

Release numbering here tells you nothing about scope. v3.4.6 and v3.4.7 both went out on 2026-10-22 and v3.4.8 on 2026-11-02, and the last push to the default branch `main` is dated 2026-10-28. Three patch releases in that span is a fast cadence for anything that touches a proxy control plane, which is a reason to read each release note before bumping a live deployment rather than pulling the highest tag. Licensing is AGPL-3.0, and the text sits in a file named `LICENCE` at the root. Read that file before forking or redistributing.

Xray-core is named, and never configured

The single architectural claim in the repository is that Remnawave sits on top of Xray-core. Nothing in the tree touches Xray. There is no core config template, no inbound or outbound definition, no node inventory, no subscription handling and no database schema. So the feature surface that would justify picking this panel over any other Xray front end is entirely undocumented here, and the words simplicity and ease of use carry no technical content until you read docs.rw. What you can verify locally is much narrower: that the site builds, that Caddy serves it and that the sources are TypeScript. Judge the panel itself from the documentation and the release assets, and treat the claims about it, including the dependency on Xray-core, as unconfirmed by this repository.

Editorial conclusion

Remnawave suits operators who already run Xray-core and want a control plane in front of it, but judge it from docs.rw and the release assets, because this repository will not get you to a running panel. Before deploying, confirm what the panel binary itself needs at runtime, since the manifest and Dockerfile here describe a Node 22 documentation site and a Caddy static server.

Frequently asked questions

What is Remnawave and what is it built on?

Remnawave is a proxy management tool built on top of Xray-core, written in TypeScript and released under AGPL-3.0. The project description says it focuses on simplicity and ease of use, and its documentation site lives at docs.rw.

Where do I install the Remnawave panel from?

The repository carries no install command at all. Its only outbound links point to docs.rw, the GitHub releases page holding v3.4.8 and earlier, and a Telegram channel at t.me/remnawave, so install steps and release assets have to come from those places.

Does the Dockerfile in the Remnawave repository run the panel?

No. It starts from Caddy 2.10 on alpine, copies the `build` and `landing` directories into /app, installs the Caddyfile at /etc/caddy/Caddyfile and runs caddy with the caddyfile adapter. Its image name argument is remnawave-docs, so it is built to serve the documentation site.

What version of Node does the Remnawave repository need?

The manifest declares engines node >=22.0. That manifest is `@remnawave/docs`, the Docusaurus documentation site, so the floor governs building the docs rather than running the panel.

Is the Remnawave repository still receiving changes?

The repository is not archived and its last push is dated 2026-10-28. Releases v3.4.8, v3.4.7 and v3.4.6 shipped on 2026-11-02, 2026-10-22 and 2026-10-22, so check the release notes for what changed rather than inferring from the patch number.

Can I fork or redistribute Remnawave?

The project is licensed under AGPL-3.0 and the licence text is in a file named `LICENCE` at the repository root. Read that file before forking or redistributing, particularly for a network facing deployment.

Official sources

  1. License: AGPL-3.0
  2. Project website
  3. README
  4. Releases
  5. remnawave/panel on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/remnawave-panel.svg)](https://hysenlabs.com/projects/remnawave-panel)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/remnawave-panel.svg)](https://hysenlabs.com/projects/remnawave-panel)

Was this useful?