Get started
A guided path from prerequisites to a first deployment you can reach over a domain.
This section is a progressive path, not a pile of articles. Each step states what you need before it and what you should see when it works. Follow them in order the first time; after that, use them as reference.
If you would rather understand the platform before installing it, read Discover Notploy first — the core concepts page in particular will make the steps below obvious rather than memorized.
The path
1. Check prerequisites
Know what server and access you need before you start: OS, resources, network ports and accounts.
Outcome: you have a host that meets the requirements and can reach it over SSH.
2. Install Notploy
Choose the quick install script or a manual Docker Compose setup.
→ Installation · Manual installation
Outcome: the Notploy containers are running and the web interface answers on port 3000.
3. Complete the initial setup
Create the administrator account and orient yourself in the dashboard.
→ First login · Interface overview
Outcome: you are signed in as the owner of your organization.
4. Connect a source
Connect a Git provider, or add a source repository or container image.
Outcome: Notploy can see at least one repository or image to deploy.
5. Deploy your first application
Create a project, add an application, and deploy it.
→ Deploy your first application
Outcome: a deployment reaches running and the app serves traffic.
6. Put it behind a domain and TLS
Route a hostname to the service and enable HTTPS.
Outcome: https://your-domain serves your application over TLS.
7. Verify it
Confirm the deployment is healthy and know where to look when it is not.
Outcome: you can read deployment status and logs confidently.
8. Learn to operate it
Know how to update Notploy, back up and restore, and uninstall safely.
→ Upgrade, backup and restore · Uninstall
Outcome: you can maintain and, if needed, cleanly remove the installation.
Where to go next
Once the path is complete, continue with the area that matches your work:
- Applications & deployment — sources, build types, Compose, databases, domains.
- Infrastructure — servers, Docker, Traefik, DNS, storage.
- Operate & administer — monitoring, maintenance, access control, troubleshooting.
- Develop & integrate — CLI, API, SDK, MCP and CI/CD.