# SixPanel documentation

> Source: https://www.allsweb.com/sixpanel/docs
> Markdown for agents: https://www.allsweb.com/sixpanel/docs.md
> Publisher: AllsWeb (www.allsweb.com)

The manual that ships with SixPanel, in reading order. It starts from a bare server and ends with a shop that takes orders — every page is a step you can do in one sitting. The same pages are on your own server after installation, so you can read them offline.

## Pages, in reading order

1. [Start here](https://www.allsweb.com/sixpanel/docs/start-here) — markdown: https://www.allsweb.com/sixpanel/docs/start-here.md
   - What SixPanel is · What SixPanel is not · What your server must be · The path from nothing to a live project · The rest, for when you need it · How long it takes · Where to get help
2. [Install SixPanel](https://www.allsweb.com/sixpanel/docs/install) — markdown: https://www.allsweb.com/sixpanel/docs/install.md
   - 1. Check the server is allowed · 2. Do this first: point your domain at the server · 3. Log in to the server and become root · 4. Run the install command · 5. Watch it work · 6. Save what it prints · 7. Open the three ports at your provider — before you try to log in · How to check it worked · If it went wrong
3. [Firewall and ports](https://www.allsweb.com/sixpanel/docs/firewall) — markdown: https://www.allsweb.com/sixpanel/docs/firewall.md
   - Only three ports, ever · Add the rules at your provider · Optional: block everything else at the edge · How to check it worked · If it went wrong
4. [First login and the setup wizard](https://www.allsweb.com/sixpanel/docs/first-login) — markdown: https://www.allsweb.com/sixpanel/docs/first-login.md
   - 1. Open the whole address · 2. Click through the certificate warning — once · 3. Log in · 4. Set up two-factor login · 5. Walk through the setup wizard · 6. Create your first project · How to check it worked · If it went wrong
5. [The panel, page by page](https://www.allsweb.com/sixpanel/docs/panel-tour) — markdown: https://www.allsweb.com/sixpanel/docs/panel-tour.md
   - Two groups of pages · Panel pages · Project pages · How to check it worked · If it went wrong
6. [Domains and HTTPS](https://www.allsweb.com/sixpanel/docs/domain-ssl) — markdown: https://www.allsweb.com/sixpanel/docs/domain-ssl.md
   - How this works, in four sentences · The three groups · 1. Add the name · 2. Point it at this server · 3. Get HTTPS · If you use Cloudflare · Adding more names to one project · How to check it worked · If it went wrong
7. [Put your code in a git repository](https://www.allsweb.com/sixpanel/docs/put-your-code-in-git) — markdown: https://www.allsweb.com/sixpanel/docs/put-your-code-in-git.md
   - Do you have to do this? · The repository must be private · 1. Find the Laravel root · 2. Leave out what does not belong · 3a. Create the repository — GitHub Desktop · 3b. Create the repository — the terminal · 4. Copy the address SixPanel needs · 5. How SixPanel signs in to a private repository · How to check it worked · If it went wrong
8. [Install your 6ammart code](https://www.allsweb.com/sixpanel/docs/install-app) — markdown: https://www.allsweb.com/sixpanel/docs/install-app.md
   - Zip or git — pick one · And then: automatic or the browser wizard · The automatic install · The browser-wizard install · How to check it worked · If it went wrong
9. [Deploy and update your code](https://www.allsweb.com/sixpanel/docs/deploy-update) — markdown: https://www.allsweb.com/sixpanel/docs/deploy-update.md
   - Four ways to run an update · 1. The Update button · 1b. Update from a zip · 2. Automatic deploys on every push · 3. Over SSH · History and going back · What actually runs · How to check it worked · If it went wrong
10. [Move an existing site here](https://www.allsweb.com/sixpanel/docs/move-existing-site) — markdown: https://www.allsweb.com/sixpanel/docs/move-existing-site.md
   - What is copied, and what is not · 1. Find the folder on the old server · 2. Pick your moment · 3. Run the transfer · 4. Test before you switch anything · 5. Switch the domain over · Bringing a dump and uploads by hand · How to check it worked · If it went wrong
11. [Backups](https://www.allsweb.com/sixpanel/docs/backups) — markdown: https://www.allsweb.com/sixpanel/docs/backups.md
   - The two rules · 1. Choose where backups are kept · 2. Save the backup password · 3. Pick a schedule · 4. Run one now · 5. Prove the backup can be restored · 6. What is inside a backup · 7. Restore a backup · How to check it worked · If it went wrong
12. [Security](https://www.allsweb.com/sixpanel/docs/security) — markdown: https://www.allsweb.com/sixpanel/docs/security.md
   - Read this first: the panel is the server · What is on the page · 1. Your username · 2. Your password · 3. Two-factor login · 4. Signed-in devices · 5. The secret panel link · 6. Give the panel your own domain · 7. The panel port · 8. Limit login to your own addresses (optional) · 9. Let someone else in · 10. Read the activity log · What is already on, with no setup · What protects the shop itself, with no setup · Would you know if something changed? · Two things about your project, not the panel · How to check it worked · If it went wrong
13. [The customer website](https://www.allsweb.com/sixpanel/docs/customer-website) — markdown: https://www.allsweb.com/sixpanel/docs/customer-website.md
   - 1. Deploy the website code · 2. Give it a domain · 3. Turn the website service on · 4. Update it later · How to check it worked · If it went wrong
14. [Live order updates (websockets)](https://www.allsweb.com/sixpanel/docs/live-updates) — markdown: https://www.allsweb.com/sixpanel/docs/live-updates.md
   - 1. Turn it on · 2. Optional: give it its own name · 3. If you use Cloudflare · 4. Turning it off · How to check it worked · If it went wrong
15. [More than one project on this server](https://www.allsweb.com/sixpanel/docs/multiple-projects) — markdown: https://www.allsweb.com/sixpanel/docs/multiple-projects.md
   - What a project actually is · 1. Create the project · 2. Then install its code · 3. Moving between projects · 4. Sizing the server · 5. Backups with several projects · 6. Deleting a project · How to check it worked · If it went wrong
16. [The `sixpanel` command line](https://www.allsweb.com/sixpanel/docs/cli) — markdown: https://www.allsweb.com/sixpanel/docs/cli.md
   - Start with these three · The five you will actually use · The seven that get you back in · Which of these work when the panel is down · Getting help · Safety rules that are true everywhere · Full reference — you will not need most of this · If it went wrong
17. [Update SixPanel itself](https://www.allsweb.com/sixpanel/docs/update-sixpanel) — markdown: https://www.allsweb.com/sixpanel/docs/update-sixpanel.md
   - 1. Which build am I on? · 2. Update from the panel · 3. Update over SSH · 4. What actually happens · 5. When the panel says it cannot do it · How to check it worked · If it went wrong
18. [When something is broken](https://www.allsweb.com/sixpanel/docs/troubleshooting) — markdown: https://www.allsweb.com/sixpanel/docs/troubleshooting.md
   - Start here · The panel will not open · The site is down, or every page shows a 500 error · The services are all green and the site still answers nothing · Order times and reports are wrong by a few hours · SSL failed, or the padlock is missing · A deploy failed, or a git push does nothing · The disk is full · The server is slow · Emails are not sending, or orders are stuck · I changed a setting and nothing happened · Live updates are dead · A helper says the panel refuses them · The backup test says FAILED · A backup fails with "repository is already locked" · A page fails with "Table … doesn't exist" · Files: uploads stopped working after I copied something in by hand · An image will not save, and nothing says why · The Files tab only shows the app and the website · The installer refuses my server · Still stuck? Send one file
19. [Questions people ask](https://www.allsweb.com/sixpanel/docs/faq) — markdown: https://www.allsweb.com/sixpanel/docs/faq.md
   - Where is everything on disk? · Where are the containers? · Which operating systems are supported? · Can I reach the panel without a domain? · I lost the panel link · I lost the panel username · I lost the panel password · Do I have to use two-factor login? · Do I need a git repository, or can I just upload my zip? · Can I give my developer access without giving them my password? · Can I change my shop's name after it is installed? · How do I know my backups actually work? · Can I see the backup password? · Can I run this on one small server? · Can I run my other websites on this server too? · Can I install my own software on the server? · Does an update touch my data or my code? · Is SixPanel's own code readable on my server? · Can I resell this, or use it for a client? · What does a backup contain? · Do I need Cloudflare? · Can I change the panel's port? · Can I edit server configuration in the Files tab? · How do I get support, and what should I send?
20. [Cloudflare](https://www.allsweb.com/sixpanel/docs/cloudflare) — markdown: https://www.allsweb.com/sixpanel/docs/cloudflare.md
   - The one rule: every record is proxied · The simplest setup: one Cloudflare account for everything · Two words you need first: site and token · How many tokens do I actually need? · What Cloudflare is · Why this server wants it · Add your site to Cloudflare · Create the API token · What the page shows · Set this up for me · Sync works in both directions · What the panel does for you · What stays manual · Subdomains · What the page can tell you, and what to do about it · If something looks wrong
21. [Server updates and restarts](https://www.allsweb.com/sixpanel/docs/server-updates) — markdown: https://www.allsweb.com/sixpanel/docs/server-updates.md
   - 0. Some of this already happens by itself · 1. Why a backup first · 2. When to update · 3. Check first — this changes nothing · 4. Install the updates · 5. Restart the server when it asks · 6. If the browser will not open — the SSH fallback · How to check it worked · If it went wrong
22. [SixPreflight](https://www.allsweb.com/sixpanel/docs/preflight) — markdown: https://www.allsweb.com/sixpanel/docs/preflight.md
   - The two halves of "is my site healthy" · Connect it — once, one click · Reading the page · The deeper check · On the Health tab · When the panel cannot read it · Who can see what
23. [Let someone else in](https://www.allsweb.com/sixpanel/docs/share-access) — markdown: https://www.allsweb.com/sixpanel/docs/share-access.md
   - Temporary logins · The public demo login · How to check it worked · If it went wrong
24. [Rename a project](https://www.allsweb.com/sixpanel/docs/project-name) — markdown: https://www.allsweb.com/sixpanel/docs/project-name.md
   - The two names every project has · What the project name is used for · Rename it · What does not change · The app's own `APP_NAME` setting · How to check it worked · If it went wrong