docs: connect a prepared server to Dokploy

Aperta
#189 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
38/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, shell

Direzione di ricerca

Read docs/AGENTS.md and the existing Coolify and monitoring guides first; check the Dokploy v0.30.10 setup script and Dokploy’s Cloudflare Tunnels documentation. Update docs/dokploy.md, the README documentation table, the wiki Panels page, CHANGELOG.md, and the generated site data. Done when the guide meets the listed acceptance criteria and a maintainer verifies the deployment and audit on a prepared test server.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: docs claude enhancement panel: dokploy proposal

Why

Phase 3 promises that the flow works for Coolify, Dokploy and Openship (#7, and the usability run #23 uses all three
panels). Coolify has two guides (docs/cloudflare-tunnel.md, docs/monitoring.md) and a full section in the wiki
Panels page; Openship gets docs/openship.md in #55. Dokploy has a short section that ends with "There is no Dokploy
guide yet". A Dokploy user has to guess which address, port and user to give Dokploy, what its Setup Server button
does to a hardened server, and whether the audit stays at 0 FAIL afterwards.

Specification

User story: as someone who uses Dokploy, I want a guide that takes my server from "prepared by server-prep" to
"added in Dokploy, Setup Server done, a test app deployed, audit 0 FAIL", so that I don't undo the hardening while
connecting the panel.

Scope

In: a new docs/dokploy.md, in the style of the Coolify guides (docs/AGENTS.md), covering:

  • the answers to give server-prep for Dokploy (PANEL=dokploy, PANEL_ACCESS, PANEL_IP, EXPOSE_WEB), and where
    to find Dokploy's public key for PANEL_PUBKEY;
  • adding the server in Dokploy: SSH key, then the server form (address for the access route, port 822 or the
    SSH_PORT chosen, user root), Enter Terminal to test, then Setup Server;
  • what Setup Server does on a prepared server, from Dokploy's setup script (v0.30.10): it installs a few packages,
    RClone, Nixpacks, Buildpacks and Railpack, keeps the Docker that server-prep installed (it installs Docker only when
    it is missing), runs docker swarm init with an advertise address it finds through a public "what is my IP" service,
    creates the dokploy-network overlay network and starts its Traefik (dokploy-traefik). It only warns when something
    already listens on 80 or 443;
  • access routes: Tailscale (the server's Tailscale IP in Dokploy), public (PANEL_IP = the Dokploy host's address),
    and apps through a Cloudflare Tunnel (EXPOSE_WEB=no, tunnel to http://localhost:80, with a link to Dokploy's own
    Cloudflare Tunnels page);
  • the expected audit result after Setup Server, and which new lines are normal (panel.data_dir, panel.proxy);
  • Dokploy's Security tab on a prepared server: what is green, what is red and why (link to #156 until it ships);
  • monitoring: Dokploy does not monitor remote servers, so use docs/monitoring.md (Telegraf);
  • the Dokploy version tested.

Out: Dokploy multi-node Swarm (worker nodes need ports 2377, 7946 and 4789 open between nodes), build servers, Dokploy's
non-root mode, installing Dokploy itself, managing apps.

Acceptance criteria
  • docs/dokploy.md exists with the sections above, uses only example values (web-01, example.com,
    192.168.1.50, 203.0.113.10) and states the Dokploy version it was tested with.
  • Every command is complete and copy-pasteable, and none of them weakens the hardening: no advice to open the Swarm
    ports, Traefik's dashboard (8080) or a container port to the internet, and no --yes on a run that includes the
    ssh step (AGENTS.md, Safety rules).
  • The README ## Documentation table has a row for it, and the wiki Panels page's Dokploy section links to it instead
    of "There is no Dokploy guide yet".
  • scripts/gen-data.sh picks it up: jq '.guides[].title' site/data.json | grep -i dokploy prints it, and
    scripts/gen-data.sh --check passes.
  • A maintainer follows the guide alone on a test server prepared with PANEL=dokploy: Setup Server finishes,
    Dokploy's example app (https://github.com/Dokploy/examples.git, build path /astro) deploys and answers, and
    sudo ./server-audit.sh still shows 0 FAIL, with "Docker vs firewall" PASS. Anything that differs from the guide is
    fixed in the guide or filed as a bug before merge.
  • A CHANGELOG.md line under [Unreleased].
How to verify
  • CI checks: scripts/gen-data.sh --check, and the rest of lint.yml (unchanged by a docs PR).
  • By hand (a routine can't run Dokploy or sudo): the test-server run in the criteria above. Also check that
    sudo ss -tlnp shows the Swarm ports (2377, 7946) and that the audit's net.exposure counts them as firewalled, not
    exposed; write the result in the guide.
Where
  • docs/dokploy.md (new), docs/AGENTS.md (style), README.md (## Documentation table),
    wiki/Panels.md (Dokploy section), CHANGELOG.md, then scripts/gen-data.sh (the README table feeds the setup
    console) and commit site/data.json / site/data.js.
  • Related: #156 (Security tab), #187 (CrowdSec reads Dokploy's Traefik log), #131 (e2e Dokploy profile), #18 (beginner
    mode), #23 (usability run with three panels), #55 (the same guide for Openship).
Risks
  • Dokploy changes fast (several releases a month): the guide names the tested version, and the PR re-checks Setup
    Server against the current release.
  • Swarm and the firewall: Setup Server starts Swarm on a server where UFW denies incoming traffic. A single node needs
    none of its ports from outside, but the test run must confirm that apps still deploy and that the audit stays at 0
    FAIL. If it does not, that is a bug for the firewall step, not a reason to open ports in the guide.
  • AIDE: Setup Server adds binaries and Docker images, so the next AIDE check reports new files. The guide says this
    is expected right after Setup Server.
  • Security checklist: docs only; item 4 (no advice that opens ports or weakens SSH) and item 6 (example values only)
    apply.
Size and priority

size: M: the writing is small, but it needs a real run with Dokploy on a test server. priority: medium: the Phase 3
usability run (#23) needs it, and nothing else blocks on it today.

Decisions for the maintainer
  1. A guide in docs/ like the Coolify ones, rather than a longer wiki section. Say if you prefer the wiki.
  2. Milestone set to "Phase 3: Agent install for beginners" (its description lists guides, and #7 needs all three
    panels). Move it if Phase 2 fits better.

To build it: remove proposal and add agent-ready.

🤖 Automated by Claude Code (feature-planner routine). A maintainer reviews before anything is merged.

Lingua principale
Shell
Stelle
2
Fork
3
Merge medio
2g 14m
PR unite (30g)
47

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di exceev-consulting/server-prep

Tutte le issue di exceev-consulting/server-prep

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.