[{"data":1,"prerenderedAt":1218},["ShallowReactive",2],{"docs-navigation-en":3,"i-lucide:search":95,"i-lucide:sun":100,"i-lucide:globe":102,"i-lucide:menu":104,"i-lucide:chevron-down":106,"i-lucide:github":108,"i-lucide:map-pin":111,"docs-headings-en":113,"i-lucide:book-open":437,"i-lucide:download":439,"i-lucide:compass":441,"i-lucide:arrow-up-circle":443,"i-lucide:layers":445,"i-lucide:users":447,"i-lucide:plug":449,"i-lucide:circle-alert":451,"i-lucide:lock":453,"i-lucide:database":455,"i-lucide:folder-sync":457,"i-lucide:life-buoy":459,"i-lucide:shield-check":461,"i-lucide:archive-restore":463,"i-lucide:activity":465,"i-lucide:wrench":467,"docs-en-/docs/panel-backup":469,"i-lucide:copy":1214,"i-lucide:link":1216},[4,27],{"section":5,"items":6},"Getting started",[7,12,17,22],{"title":8,"path":9,"order":10,"icon":11},"Introduction","/docs",1,"lucide:book-open",{"title":13,"path":14,"order":15,"icon":16},"Installation","/docs/installation",2,"lucide:download",{"title":18,"path":19,"order":20,"icon":21},"Finding your way around the panel","/docs/panel-interface",2.5,"lucide:compass",{"title":23,"path":24,"order":25,"icon":26},"Upgrading Maran","/docs/upgrade",2.7,"lucide:arrow-up-circle",{"section":28,"items":29},"How it works",[30,35,40,45,50,55,60,65,70,75,80,85,90],{"title":31,"path":32,"order":33,"icon":34},"How it is built","/docs/architecture",3,"lucide:layers",{"title":36,"path":37,"order":38,"icon":39},"Hosting accounts","/docs/accounts",4,"lucide:users",{"title":41,"path":42,"order":43,"icon":44},"Websites and PHP","/docs/websites",5,"lucide:globe",{"title":46,"path":47,"order":48,"icon":49},"The provisioning API","/docs/api",6,"lucide:plug",{"title":51,"path":52,"order":53,"icon":54},"API error codes","/docs/api-errors",6.5,"lucide:circle-alert",{"title":56,"path":57,"order":58,"icon":59},"SSL certificates","/docs/ssl",7,"lucide:lock",{"title":61,"path":62,"order":63,"icon":64},"Databases","/docs/databases",8,"lucide:database",{"title":66,"path":67,"order":68,"icon":69},"File transfer and backups","/docs/file-transfer",9,"lucide:folder-sync",{"title":71,"path":72,"order":73,"icon":74},"Recovery and diagnostics","/docs/recovery",10,"lucide:life-buoy",{"title":76,"path":77,"order":78,"icon":79},"Panel certificate","/docs/panel-certificate",11,"lucide:shield-check",{"title":81,"path":82,"order":83,"icon":84},"Panel backup and restore","/docs/panel-backup",12,"lucide:archive-restore",{"title":86,"path":87,"order":88,"icon":89},"Dashboard and monitoring","/docs/monitoring",13,"lucide:activity",{"title":91,"path":92,"order":93,"icon":94},"Troubleshooting","/docs/troubleshooting",14,"lucide:wrench",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":99},0,24,false,"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"m21 21l-4.34-4.34\"/>\u003Ccircle cx=\"11\" cy=\"11\" r=\"8\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":101},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"4\"/>\u003Cpath d=\"M12 2v2m0 16v2M4.93 4.93l1.41 1.41m11.32 11.32l1.41 1.41M2 12h2m16 0h2M6.34 17.66l-1.41 1.41M19.07 4.93l-1.41 1.41\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":103},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"M12 2a14.5 14.5 0 0 0 0 20a14.5 14.5 0 0 0 0-20M2 12h20\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":105},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M4 5h16M4 12h16M4 19h16\"/>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":107},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m6 9l6 6l6-6\"/>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":109,"hidden":110},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5c.08-1.25-.27-2.48-1-3.5c.28-1.15.28-2.35 0-3.5c0 0-1 0-3 1.5c-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.4 5.4 0 0 0 4 9c0 3.5 3 5.5 6 5.5c-.39.49-.68 1.05-.85 1.65S8.93 17.38 9 18v4\"/>\u003Cpath d=\"M9 18c-4.51 2-5-2-7-2\"/>\u003C/g>",true,{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":112},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M20 10c0 4.993-5.539 10.193-7.399 11.799a1 1 0 0 1-1.202 0C9.539 20.193 4 14.993 4 10a8 8 0 0 1 16 0\"/>\u003Ccircle cx=\"12\" cy=\"10\" r=\"3\"/>\u003C/g>",{"/docs/accounts":114,"/docs/api":154,"/docs/api-errors":179,"/docs/architecture":192,"/docs/databases":208,"/docs/file-transfer":221,"/docs":240,"/docs/installation":253,"/docs/monitoring":269,"/docs/panel-backup":288,"/docs/panel-certificate":307,"/docs/panel-interface":326,"/docs/recovery":355,"/docs/ssl":380,"/docs/troubleshooting":389,"/docs/upgrade":402,"/docs/websites":418},[115,118,121,124,127,130,133,136,139,142,145,148,151],{"title":116,"anchor":117},"What creating one does","what-creating-one-does",{"title":119,"anchor":120},"The new account form","the-new-account-form",{"title":122,"anchor":123},"Suspension is a state, not a deletion","suspension-is-a-state-not-a-deletion",{"title":125,"anchor":126},"Deleting removes what the account left behind","deleting-removes-what-the-account-left-behind",{"title":128,"anchor":129},"Plans","plans",{"title":131,"anchor":132},"Plan features","plan-features",{"title":134,"anchor":135},"Team access: sub-users","team-access-sub-users",{"title":137,"anchor":138},"More than one account per login","more-than-one-account-per-login",{"title":140,"anchor":141},"Viewing as an account","viewing-as-an-account",{"title":143,"anchor":144},"Runtime limits","runtime-limits",{"title":146,"anchor":147},"Running a scheduled task now","running-a-scheduled-task-now",{"title":149,"anchor":150},"What a customer sees","what-a-customer-sees",{"title":152,"anchor":153},"One limitation worth knowing","one-limitation-worth-knowing",[155,158,161,164,167,170,173,176],{"title":156,"anchor":157},"A login, not a key yet","a-login-not-a-key-yet",{"title":159,"anchor":160},"The account lifecycle","the-account-lifecycle",{"title":162,"anchor":163},"Plan features, accounts and views","plan-features-accounts-and-views",{"title":165,"anchor":166},"Answers without a body","answers-without-a-body",{"title":168,"anchor":169},"Renamed response fields","renamed-response-fields",{"title":171,"anchor":172},"What it is not","what-it-is-not",{"title":174,"anchor":175},"Errors say what a caller may know","errors-say-what-a-caller-may-know",{"title":177,"anchor":178},"Every error code","every-error-code",[180,183,186,189],{"title":181,"anchor":182},"The status comes from the kind of failure","the-status-comes-from-the-kind-of-failure",{"title":184,"anchor":185},"Codes worth knowing first","codes-worth-knowing-first",{"title":187,"anchor":188},"A failed background task carries the same codes","a-failed-background-task-carries-the-same-codes",{"title":190,"anchor":191},"Every code","every-code",[193,196,199,202,205],{"title":194,"anchor":195},"The three processes","the-three-processes",{"title":197,"anchor":198},"The contract between them","the-contract-between-them",{"title":200,"anchor":201},"Writing a configuration file","writing-a-configuration-file",{"title":203,"anchor":204},"Isolation between accounts","isolation-between-accounts",{"title":206,"anchor":207},"What is deliberately absent","what-is-deliberately-absent",[209,212,215,218],{"title":210,"anchor":211},"Isolation is built, not assumed","isolation-is-built-not-assumed",{"title":213,"anchor":214},"The password is shown once","the-password-is-shown-once",{"title":216,"anchor":217},"Dropping is final","dropping-is-final",{"title":219,"anchor":220},"The grant repair, for hosts that ran an older build","the-grant-repair-for-hosts-that-ran-an-older-build",[222,225,228,231,234,237],{"title":223,"anchor":224},"Each login is jailed, and the jail is real","each-login-is-jailed-and-the-jail-is-real",{"title":226,"anchor":227},"Resetting or deleting a login ends its open sessions","resetting-or-deleting-a-login-ends-its-open-sessions",{"title":229,"anchor":230},"Public keys live outside the jail","public-keys-live-outside-the-jail",{"title":232,"anchor":233},"FTPS ships installed and switched off","ftps-ships-installed-and-switched-off",{"title":235,"anchor":236},"Backups","backups",{"title":238,"anchor":239},"What nothing re-checks","what-nothing-re-checks",[241,244,247,250],{"title":242,"anchor":243},"Three processes, and only one of them is root","three-processes-and-only-one-of-them-is-root",{"title":245,"anchor":246},"What a hosting account is","what-a-hosting-account-is",{"title":248,"anchor":249},"No brokers, no sidecars","no-brokers-no-sidecars",{"title":251,"anchor":252},"Keyboard, screen readers and motion","keyboard-screen-readers-and-motion",[254,257,260,263,266],{"title":255,"anchor":256},"Run the installer","run-the-installer",{"title":258,"anchor":259},"Installing without internet access","installing-without-internet-access",{"title":261,"anchor":262},"The first administrator","the-first-administrator",{"title":264,"anchor":265},"After the first sign-in","after-the-first-sign-in",{"title":267,"anchor":268},"Updates","updates",[270,273,276,279,282,285],{"title":271,"anchor":272},"What the dashboard shows","what-the-dashboard-shows",{"title":274,"anchor":275},"A part that could not be read says so","a-part-that-could-not-be-read-says-so",{"title":277,"anchor":278},"The disk: in use, reserved, available","the-disk-in-use-reserved-available",{"title":280,"anchor":281},"Disk use by account","disk-use-by-account",{"title":283,"anchor":284},"Alerts reach the operator by mail","alerts-reach-the-operator-by-mail",{"title":286,"anchor":287},"Panel log level","panel-log-level",[289,292,295,298,301,304],{"title":290,"anchor":291},"The passphrase file","the-passphrase-file",{"title":293,"anchor":294},"Take a backup","take-a-backup",{"title":296,"anchor":297},"What the archive contains","what-the-archive-contains",{"title":299,"anchor":300},"Restore onto a clean server","restore-onto-a-clean-server",{"title":302,"anchor":303},"Schedule it, keep a few, send a copy off the server","schedule-it-keep-a-few-send-a-copy-off-the-server",{"title":305,"anchor":306},"Limitations","limitations",[308,311,314,317,320,323],{"title":309,"anchor":310},"Order one","order-one",{"title":312,"anchor":313},"The host name comes from the server","the-host-name-comes-from-the-server",{"title":315,"anchor":316},"The port 80 challenge block","the-port-80-challenge-block",{"title":318,"anchor":319},"Renewal","renewal",{"title":321,"anchor":322},"When issuance fails","when-issuance-fails",{"title":324,"anchor":325},"Limits to know","limits-to-know",[327,330,333,336,339,342,345,346,349,352],{"title":328,"anchor":329},"The sidebar and the breadcrumb","the-sidebar-and-the-breadcrumb",{"title":331,"anchor":332},"Light, dark or system theme","light-dark-or-system-theme",{"title":334,"anchor":335},"Favourites","favourites",{"title":337,"anchor":338},"The server selector","the-server-selector",{"title":340,"anchor":341},"Switching between accounts","switching-between-accounts",{"title":343,"anchor":344},"The attention badge","the-attention-badge",{"title":140,"anchor":141},{"title":347,"anchor":348},"Lists: search, filters and pages","lists-search-filters-and-pages",{"title":350,"anchor":351},"Tables on a phone","tables-on-a-phone",{"title":353,"anchor":354},"Background tasks and their progress","background-tasks-and-their-progress",[356,359,362,365,368,371,374,377],{"title":357,"anchor":358},"Run it as root","run-it-as-root",{"title":360,"anchor":361},"Reset an administrator's password","reset-an-administrators-password",{"title":363,"anchor":364},"When correct two-factor codes are refused","when-correct-two-factor-codes-are-refused",{"title":366,"anchor":367},"Change your own password","change-your-own-password",{"title":369,"anchor":370},"Check server health","check-server-health",{"title":372,"anchor":373},"Free-space floor","free-space-floor",{"title":375,"anchor":376},"Collect a support bundle","collect-a-support-bundle",{"title":378,"anchor":379},"Read the logs, and change how much is written","read-the-logs-and-change-how-much-is-written",[381,384,385,388],{"title":382,"anchor":383},"Where the private key goes","where-the-private-key-goes",{"title":318,"anchor":319},{"title":386,"anchor":387},"What this client has not done","what-this-client-has-not-done",{"title":324,"anchor":325},[390,393,396,399],{"title":391,"anchor":392},"The panel will not start","the-panel-will-not-start",{"title":394,"anchor":395},"A site answers 502 or 404","a-site-answers-502-or-404",{"title":397,"anchor":398},"A certificate is not issued","a-certificate-is-not-issued",{"title":400,"anchor":401},"The agent is unreachable","the-agent-is-unreachable",[403,406,409,412,415],{"title":404,"anchor":405},"1. Take a panel backup first","_1-take-a-panel-backup-first",{"title":407,"anchor":408},"2. Run the installer again","_2-run-the-installer-again",{"title":410,"anchor":411},"What the installer keeps and what it changes","what-the-installer-keeps-and-what-it-changes",{"title":413,"anchor":414},"3. Check the result","_3-check-the-result",{"title":416,"anchor":417},"If the upgrade fails","if-the-upgrade-fails",[419,422,425,428,431,434],{"title":420,"anchor":421},"Configuration is validated by the server itself","configuration-is-validated-by-the-server-itself",{"title":423,"anchor":424},"Values are validated, not escaped","values-are-validated-not-escaped",{"title":426,"anchor":427},"Aliases","aliases",{"title":429,"anchor":430},"Closed sets are chosen, not typed","closed-sets-are-chosen-not-typed",{"title":432,"anchor":433},"Several PHP versions at once","several-php-versions-at-once",{"title":435,"anchor":436},"Logs","logs",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":438},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 5v16m8.001-2A2 2 0 0 0 22 17V5a2 2 0 0 0-1.999-2L16 3.002A5 5 0 0 0 12 5a5 5 0 0 0-4-2H4a2 2 0 0 0-2 2v12a2 2 0 0 0 1.999 2H8a5 5 0 0 1 4 2a5 5 0 0 1 4-2z\"/>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":440},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12 15V3m9 12v4a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-4\"/>\u003Cpath d=\"m7 10l5 5l5-5\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":442},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"m16.24 7.76l-1.804 5.411a2 2 0 0 1-1.265 1.265L7.76 16.24l1.804-5.411a2 2 0 0 1 1.265-1.265z\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":444},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"m16 12l-4-4l-4 4m4 4V8\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":446},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12.83 2.18a2 2 0 0 0-1.66 0L2.6 6.08a1 1 0 0 0 0 1.83l8.58 3.91a2 2 0 0 0 1.66 0l8.58-3.9a1 1 0 0 0 0-1.83z\"/>\u003Cpath d=\"M2 12a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 12\"/>\u003Cpath d=\"M2 17a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 17\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":448},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M16 21v-2a4 4 0 0 0-4-4H6a4 4 0 0 0-4 4v2M16 3.128a4 4 0 0 1 0 7.744M22 21v-2a4 4 0 0 0-3-3.87\"/>\u003Ccircle cx=\"9\" cy=\"7\" r=\"4\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":450},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 22v-5m3-9V2m2 6a1 1 0 0 1 1 1v4a4 4 0 0 1-4 4h-4a4 4 0 0 1-4-4V9a1 1 0 0 1 1-1zM9 8V2\"/>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":452},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"M12 8v4m0 4h.01\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":454},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"18\" height=\"11\" x=\"3\" y=\"11\" rx=\"2\" ry=\"2\"/>\u003Cpath d=\"M7 11V7a5 5 0 0 1 10 0v4\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":456},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cellipse cx=\"12\" cy=\"5\" rx=\"9\" ry=\"3\"/>\u003Cpath d=\"M3 5v14a9 3 0 0 0 18 0V5\"/>\u003Cpath d=\"M3 12a9 3 0 0 0 18 0\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":458},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M9 20H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h3.9a2 2 0 0 1 1.69.9l.81 1.2a2 2 0 0 0 1.67.9H20a2 2 0 0 1 2 2v.5\"/>\u003Cpath d=\"M12 10v4h4\"/>\u003Cpath d=\"m12 14l1.535-1.605a5 5 0 0 1 8 1.5M22 22v-4h-4\"/>\u003Cpath d=\"m22 18l-1.535 1.605a5 5 0 0 1-8-1.5\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":460},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"m4.93 4.93l4.24 4.24m5.66 0l4.24-4.24m-4.24 9.9l4.24 4.24m-9.9-4.24l-4.24 4.24\"/>\u003Ccircle cx=\"12\" cy=\"12\" r=\"4\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":462},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z\"/>\u003Cpath d=\"m9 12l2 2l4-4\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":464},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"20\" height=\"5\" x=\"2\" y=\"3\" rx=\"1\"/>\u003Cpath d=\"M4 8v11a2 2 0 0 0 2 2h2M20 8v11a2 2 0 0 1-2 2h-2m-7-6l3-3l3 3m-3-3v9\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":466},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M22 12h-2.48a2 2 0 0 0-1.93 1.46l-2.35 8.36a.25.25 0 0 1-.48 0L9.24 2.18a.25.25 0 0 0-.48 0l-2.35 8.36A2 2 0 0 1 4.49 12H2\"/>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":468},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M14.7 6.3a1 1 0 0 0 0 1.4l1.6 1.6a1 1 0 0 0 1.4 0l3.106-3.105c.32-.322.863-.22.983.218a6 6 0 0 1-8.259 7.057l-7.91 7.91a1 1 0 0 1-2.999-3l7.91-7.91a6 6 0 0 1 7.057-8.259c.438.12.54.662.219.984z\"/>",{"doc":470,"isFallback":98},{"id":471,"title":81,"body":472,"description":1205,"extension":1206,"icon":84,"meta":1207,"navigation":110,"order":83,"path":1208,"rawbody":1209,"section":28,"seo":1210,"seoTitle":1211,"stem":1212,"__hash__":1213},"docsEn/en/docs/panel-backup.md",{"type":473,"value":474,"toc":1194},"minimark",[475,492,499,502,505,548,564,567,569,589,607,613,615,685,692,695,697,747,752,786,789,793,824,827,829,835,838,919,932,1044,1070,1075,1102,1112,1115,1145,1156,1167,1169,1190],[476,477,478,479,483,484,487,488,491],"p",{},"Account backups carry your customers' files and databases. They do not include the panel itself:\nits own database (administrators, accounts, plans, sites, schedules, the audit journal), the key\nevery stored secret is encrypted with, the licence and ",[480,481,482],"code",{},"/etc/maran",". Without the key, a new server\ncannot read the secrets in a copied database. ",[480,485,486],{},"maran panel-backup"," and ",[480,489,490],{},"maran panel-restore"," cover\nthis.",[476,493,494,495,498],{},"Both work only as root, like the rest of the ",[480,496,497],{},"maran"," command. Run by hand they add no service, port\nor network call. The optional schedule described below adds a systemd timer and, only if you\nconfigure it, one outbound HTTPS upload.",[500,501,290],"h2",{"id":291},[476,503,504],{},"The archive is encrypted with a passphrase you choose, read from a file. Create it once:",[506,507,512],"pre",{"className":508,"code":509,"language":510,"meta":511,"style":511},"language-bash shiki shiki-themes github-light-high-contrast github-dark-high-contrast","sudo install -m 0600 /dev/null /root/maran-backup.passphrase\nsudo editor /root/maran-backup.passphrase\n","bash","",[480,513,514,539],{"__ignoreMap":511},[515,516,518,522,526,530,533,536],"span",{"class":517,"line":10},"line",[515,519,521],{"class":520},"soyes","sudo",[515,523,525],{"class":524},"sT6z2"," install",[515,527,529],{"class":528},"s-5SL"," -m",[515,531,532],{"class":528}," 0600",[515,534,535],{"class":524}," /dev/null",[515,537,538],{"class":524}," /root/maran-backup.passphrase\n",[515,540,541,543,546],{"class":517,"line":15},[515,542,521],{"class":520},[515,544,545],{"class":524}," editor",[515,547,538],{"class":524},[476,549,550,551,554,555,558,559,563],{},"The file must be a regular file (not a symlink), owned by root, mode ",[480,552,553],{},"0600"," or ",[480,556,557],{},"0400",", and hold\none line of ",[560,561,562],"strong",{},"at least 20 characters",". Anything else is refused before anything is written. The\npassphrase is never passed on the command line or in the environment.",[476,565,566],{},"Keep a copy of the passphrase somewhere other than the server and other than where the archives go.\nWithout it, nobody can open an archive, including you.",[500,568,293],{"id":294},[506,570,572],{"className":508,"code":571,"language":510,"meta":511,"style":511},"sudo /usr/local/sbin/maran panel-backup --passphrase-file /root/maran-backup.passphrase\n",[480,573,574],{"__ignoreMap":511},[515,575,576,578,581,584,587],{"class":517,"line":10},[515,577,521],{"class":520},[515,579,580],{"class":524}," /usr/local/sbin/maran",[515,582,583],{"class":524}," panel-backup",[515,585,586],{"class":528}," --passphrase-file",[515,588,538],{"class":524},[476,590,591,592,595,596,598,599,602,603,606],{},"It writes ",[480,593,594],{},"maran-panel-backup-\u003CUTC time>-\u003Cpid>.tar.gpg",", mode ",[480,597,553],{},", into ",[480,600,601],{},"/root"," and prints its\npath. ",[480,604,605],{},"--out DIR"," chooses another directory: an absolute path, owned by root and not writable by\ngroup or others. The panel keeps running while the backup is taken. A failed run leaves no\npartial file behind.",[476,608,609,610],{},"Copy the archive off the server. ",[560,611,612],{},"Whoever holds the archive and the passphrase holds the panel.",[500,614,296],{"id":297},[616,617,618,634],"table",{},[619,620,621],"thead",{},[622,623,624,628],"tr",{},[625,626,627],"th",{},"Part",[625,629,630,631],{},"Restored by ",[480,632,633],{},"panel-restore",[635,636,637,646,662,671],"tbody",{},[622,638,639,643],{},[640,641,642],"td",{},"The panel database, every schema",[640,644,645],{},"yes",[622,647,648,660],{},[640,649,650,487,653,656,657],{},[480,651,652],{},"Security__EncryptionKey",[480,654,655],{},"Jwt__SigningKey"," from ",[480,658,659],{},"/etc/maran/panel.env",[640,661,645],{},[622,663,664,669],{},[640,665,666],{},[480,667,668],{},"/var/lib/maran/licence.json",[640,670,645],{},[622,672,673,682],{},[640,674,675,676,487,678,681],{},"The rest of ",[480,677,482],{},[480,679,680],{},"/var/lib/maran"," (the panel's TLS key, rendered configs, ACME material)",[640,683,684],{},"no, inside the archive for manual use",[476,686,687,688,691],{},"Everything else in ",[480,689,690],{},"panel.env"," (the host name, ssh ports, the web server's uid) describes the server\nit is on, so a restore keeps what the new install wrote.",[476,693,694],{},"The archive is encrypted with gpg (AES-256) with integrity protection. A changed or truncated\narchive is refused and never restored.",[500,696,299],{"id":300},[698,699,700,704,707,741,744],"ol",{},[701,702,703],"li",{},"Install Maran on the new server, the same release as the backup or a newer one. Do not create an\nadministrator in the browser.",[701,705,706],{},"Copy the archive to the new server, owned by root, and recreate the passphrase file there.",[701,708,709,710],{},"Restore:",[506,711,713],{"className":508,"code":712,"language":510,"meta":511,"style":511},"sudo /usr/local/sbin/maran panel-restore --passphrase-file /root/maran-backup.passphrase \\\n  --replace-this-panel /root/maran-panel-backup-20261101T120000Z-4242.tar.gpg\n",[480,714,715,733],{"__ignoreMap":511},[515,716,717,719,721,724,726,729],{"class":517,"line":10},[515,718,521],{"class":520},[515,720,580],{"class":524},[515,722,723],{"class":524}," panel-restore",[515,725,586],{"class":528},[515,727,728],{"class":524}," /root/maran-backup.passphrase",[515,730,732],{"class":731},"sHUrx"," \\\n",[515,734,735,738],{"class":517,"line":15},[515,736,737],{"class":528},"  --replace-this-panel",[515,739,740],{"class":524}," /root/maran-panel-backup-20261101T120000Z-4242.tar.gpg\n",[701,742,743],{},"Sign in with an administrator of the old panel. Every session from the old server has ended.",[701,745,746],{},"Restore customers' files, sites and databases from the account backups. A panel backup holds\nthe panel's records of them, not their contents.",[748,749,751],"h3",{"id":750},"the-order-a-restore-follows","The order a restore follows",[698,753,754,757,763,766,772,777,780,783],{},[701,755,756],{},"Decrypt and check the archive and its format version.",[701,758,759,760,762],{},"Check the two keys in the archived ",[480,761,690],{},".",[701,764,765],{},"Stop the panel.",[701,767,768,769,762],{},"Replace the database in ",[560,770,771],{},"one transaction",[701,773,774,775,762],{},"Write the two keys into this server's ",[480,776,690],{},[701,778,779],{},"Put the licence back.",[701,781,782],{},"Apply this release's migrations.",[701,784,785],{},"Start the panel.",[476,787,788],{},"If the database replacement fails, its transaction rolls back and the database stays as the install\nleft it. If anything fails after the panel has been stopped, the panel is started again.",[748,790,792],{"id":791},"what-it-refuses","What it refuses",[794,795,796,803,806,809,815,818,821],"ul",{},[701,797,798,799,802],{},"running without ",[480,800,801],{},"--replace-this-panel",", because a restore replaces this panel's database and keys;",[701,804,805],{},"a passphrase file that fails the rules above;",[701,807,808],{},"an archive that is not an absolute path, not a regular file, or not owned by root;",[701,810,811,812,814],{},"a server with no ",[480,813,659],{}," (install Maran first);",[701,816,817],{},"a wrong passphrase or a damaged archive, before anything changes;",[701,819,820],{},"an archive format this release does not restore;",[701,822,823],{},"a second backup or restore while one is already running.",[476,825,826],{},"Nothing from the archive is executed. Only the named files are taken out of it, and the keys are\nchecked before they are written.",[500,828,302],{"id":303},[476,830,831,832,834],{},"Scheduling, retention and the S3 upload are not in 1.0.0-beta.4. They arrive with the next release.\nOn 1.0.0-beta.4, run ",[480,833,486],{}," from root's crontab and copy the file with your own\ntooling.",[476,836,837],{},"From the next release the installer puts the timer and its service on the server but never turns\nthem on. You write a settings file first:",[506,839,841],{"className":508,"code":840,"language":510,"meta":511,"style":511},"sudo install -d -m 0700 /etc/maran-backup\nsudo install -m 0600 /dev/null /etc/maran-backup/passphrase\nsudo editor /etc/maran-backup/passphrase\nsudo install -m 0600 /usr/local/maran/cli/panel-backup.conf.example /etc/maran/panel-backup.conf\nsudo editor /etc/maran/panel-backup.conf\nsudo /usr/local/sbin/maran panel-backup-schedule enable\n",[480,842,843,860,875,883,899,907],{"__ignoreMap":511},[515,844,845,847,849,852,854,857],{"class":517,"line":10},[515,846,521],{"class":520},[515,848,525],{"class":524},[515,850,851],{"class":528}," -d",[515,853,529],{"class":528},[515,855,856],{"class":528}," 0700",[515,858,859],{"class":524}," /etc/maran-backup\n",[515,861,862,864,866,868,870,872],{"class":517,"line":15},[515,863,521],{"class":520},[515,865,525],{"class":524},[515,867,529],{"class":528},[515,869,532],{"class":528},[515,871,535],{"class":524},[515,873,874],{"class":524}," /etc/maran-backup/passphrase\n",[515,876,877,879,881],{"class":517,"line":33},[515,878,521],{"class":520},[515,880,545],{"class":524},[515,882,874],{"class":524},[515,884,885,887,889,891,893,896],{"class":517,"line":38},[515,886,521],{"class":520},[515,888,525],{"class":524},[515,890,529],{"class":528},[515,892,532],{"class":528},[515,894,895],{"class":524}," /usr/local/maran/cli/panel-backup.conf.example",[515,897,898],{"class":524}," /etc/maran/panel-backup.conf\n",[515,900,901,903,905],{"class":517,"line":43},[515,902,521],{"class":520},[515,904,545],{"class":524},[515,906,898],{"class":524},[515,908,909,911,913,916],{"class":517,"line":48},[515,910,521],{"class":520},[515,912,580],{"class":524},[515,914,915],{"class":524}," panel-backup-schedule",[515,917,918],{"class":524}," enable\n",[476,920,921,924,925,928,929,931],{},[480,922,923],{},"/etc/maran/panel-backup.conf"," is data, not a shell script: one ",[480,926,927],{},"KEY=VALUE"," per line, no quotes, no\nspaces, an unknown or repeated key is refused. It must be owned by root with mode ",[480,930,553],{},". It holds\nno secret. It only names the files that do:",[616,933,934,944],{},[619,935,936],{},[622,937,938,941],{},[625,939,940],{},"Key",[625,942,943],{},"Meaning",[635,945,946,956,974,984,1016],{},[622,947,948,953],{},[640,949,950],{},[480,951,952],{},"PASSPHRASE_FILE",[640,954,955],{},"Required. The passphrase file, with the same rules as above.",[622,957,958,963],{},[640,959,960],{},[480,961,962],{},"OUT_DIR",[640,964,965,966,969,970,973],{},"Where archives are written. Default ",[480,967,968],{},"/var/backups/maran-panel",", which the installer creates for root only. Another directory must exist first (root-owned, mode ",[480,971,972],{},"0700",").",[622,975,976,981],{},[640,977,978],{},[480,979,980],{},"KEEP",[640,982,983],{},"How many archives to keep, 1 to 365. Default 14.",[622,985,986,991],{},[640,987,988],{},[480,989,990],{},"SCHEDULE",[640,992,993,994,997,998,1001,1002,1005,1006,1005,1009,487,1012,1015],{},"When to run, as a systemd calendar time such as ",[480,995,996],{},"*-*-* 02:30:00"," (the default, every day) or ",[480,999,1000],{},"Sun *-*-* 03:00:00","; ",[480,1003,1004],{},"hourly",", ",[480,1007,1008],{},"daily",[480,1010,1011],{},"weekly",[480,1013,1014],{},"monthly"," also work. The timer adds up to 15 minutes of random delay.",[622,1017,1018,1038],{},[640,1019,1020,1005,1023,1005,1026,1005,1029,1005,1032,1005,1035],{},[480,1021,1022],{},"S3_ENDPOINT",[480,1024,1025],{},"S3_BUCKET",[480,1027,1028],{},"S3_REGION",[480,1030,1031],{},"S3_ACCESS_KEY_ID_FILE",[480,1033,1034],{},"S3_SECRET_FILE",[480,1036,1037],{},"S3_PREFIX",[640,1039,1040,1041,1043],{},"Optional upload. Set all of them except ",[480,1042,1037],{}," (an optional folder in the bucket), or none. The two credential files hold one value each.",[476,1045,1046,1047,487,1049,1052,1053,1056,1057,1059,1060,1062,1063,1066,1067,1069],{},"Keep the passphrase file and the S3 credential files outside ",[480,1048,601],{},[480,1050,1051],{},"/home",", for example in\n",[480,1054,1055],{},"/etc/maran-backup"," (root-owned, mode ",[480,1058,972],{},", each file ",[480,1061,553],{},"). The scheduled job cannot see those\ntwo trees, and ",[480,1064,1065],{},"enable"," refuses a path under them. Do not keep them under ",[480,1068,482],{}," either: that\ndirectory is inside the archive, and a passphrase stored in the archive it protects protects\nnothing.",[476,1071,1072,1074],{},[480,1073,1065],{}," checks the file and the schedule, then starts the timer. If anything is wrong it names the\nfirst problem and changes nothing. Afterwards:",[506,1076,1078],{"className":508,"code":1077,"language":510,"meta":511,"style":511},"sudo /usr/local/sbin/maran panel-backup-schedule status\nsudo /usr/local/sbin/maran panel-backup-schedule disable\n",[480,1079,1080,1091],{"__ignoreMap":511},[515,1081,1082,1084,1086,1088],{"class":517,"line":10},[515,1083,521],{"class":520},[515,1085,580],{"class":524},[515,1087,915],{"class":524},[515,1089,1090],{"class":524}," status\n",[515,1092,1093,1095,1097,1099],{"class":517,"line":15},[515,1094,521],{"class":520},[515,1096,580],{"class":524},[515,1098,915],{"class":524},[515,1100,1101],{"class":524}," disable\n",[476,1103,1104,1107,1108,1111],{},[480,1105,1106],{},"status"," shows whether the timer is enabled and active, its next and last run, and how the last run\nended. ",[480,1109,1110],{},"disable"," stops the timer and leaves your settings and every archive where they are.",[476,1113,1114],{},"Each run is the same backup as the manual one, taken by the timer as root. A machine that was off at\nthe scheduled time takes its backup when it next starts. Then, in this order:",[698,1116,1117,1132],{},[701,1118,1119,1122,1123,1125,1126,1128,1129,1131],{},[560,1120,1121],{},"Retention."," Only after the new archive exists, the newest ",[480,1124,980],{}," are kept. Older ones are\nremoved from ",[480,1127,962],{},", and only files whose whole name is ",[480,1130,594],{},"\nand that are regular files. Anything else in the directory is left alone. Retention never touches\ncopies in S3.",[701,1133,1134,1137,1138,1140,1141,1144],{},[560,1135,1136],{},"Upload",", only if ",[480,1139,1022],{}," is set. The already-encrypted ",[480,1142,1143],{},".tar.gpg"," file is sent over\nHTTPS (TLS 1.2 or newer, no redirects, certificates always checked), and the upload counts as\ndone only when the stored object has the same size as the local file. A network error or a 5xx\nis tried three times, ten seconds apart. The credentials are never put on a command line or in\nthe log.",[476,1146,1147,1148,1151,1152,1155],{},"If retention or the upload fails, the archive stays on the server and the run is reported as failed\n(",[480,1149,1150],{},"systemctl status maran-panel-backup.service","). Each run also leaves one line in the system journal\nunder the ",[480,1153,1154],{},"maran-cli"," tag, with the outcome and nothing else. Uninstalling Maran removes the timer\nand never the archives.",[476,1157,1158,1159,1161,1162,1166],{},"To restore from an off-site copy, download the ",[480,1160,1143],{}," file to the new server, owned by root, and\nfollow ",[1163,1164,299],"a",{"href":1165},"#restore-onto-a-clean-server",". The passphrase is still the one\nthat encrypted it.",[500,1168,305],{"id":306},[794,1170,1171,1174,1181,1184,1187],{},[701,1172,1173],{},"Retention, the schedule and the upload work from the next release, as described above. The upload\nspeaks the S3 API to an endpoint you name, over HTTPS only. There is no command that fetches an\narchive back from S3: download it with your own tooling.",[701,1175,1176,1177,1180],{},"Restoring an archive from a ",[560,1178,1179],{},"newer"," release onto an older install is not refused by the\ncommand. Install the same release or a newer one first.",[701,1182,1183],{},"A licence bound to the old server may need to be re-issued for the new one.",[701,1185,1186],{},"The panel's TLS certificate, rendered configs and ACME material are not put back automatically;\ntake them from the archive by hand if you need them.",[701,1188,1189],{},"If the server loses power during a backup, the unencrypted staging copy stays in a root-only\ndirectory until the next run of either command clears it.",[1191,1192,1193],"style",{},"html pre.shiki code .soyes, html code.shiki .soyes{--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .sT6z2, html code.shiki .sT6z2{--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .s-5SL, html code.shiki .s-5SL{--shiki-default:#023B95;--shiki-dark:#91CBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sHUrx, html code.shiki .sHUrx{--shiki-default:#A0111F;--shiki-dark:#FF9492}",{"title":511,"searchDepth":15,"depth":15,"links":1195},[1196,1197,1198,1199,1203,1204],{"id":291,"depth":15,"text":290},{"id":294,"depth":15,"text":293},{"id":297,"depth":15,"text":296},{"id":300,"depth":15,"text":299,"children":1200},[1201,1202],{"id":750,"depth":33,"text":751},{"id":791,"depth":33,"text":792},{"id":303,"depth":15,"text":302},{"id":306,"depth":15,"text":305},"Back up the panel itself, its database, encryption keys, licence and configuration, into one encrypted archive, and restore it on a clean server.","md",{},"/en/docs/panel-backup","---\ntitle: Panel backup and restore\ndescription: 'Back up the panel itself, its database, encryption keys, licence and configuration, into one encrypted archive, and restore it on a clean server.'\nseoTitle: 'Back up and restore the panel itself'\nsection: How it works\norder: 12\nicon: lucide:archive-restore\n---\n\nAccount backups carry your customers' files and databases. They do not include the panel itself:\nits own database (administrators, accounts, plans, sites, schedules, the audit journal), the key\nevery stored secret is encrypted with, the licence and `/etc/maran`. Without the key, a new server\ncannot read the secrets in a copied database. `maran panel-backup` and `maran panel-restore` cover\nthis.\n\nBoth work only as root, like the rest of the `maran` command. Run by hand they add no service, port\nor network call. The optional schedule described below adds a systemd timer and, only if you\nconfigure it, one outbound HTTPS upload.\n\n## The passphrase file\n\nThe archive is encrypted with a passphrase you choose, read from a file. Create it once:\n\n```bash\nsudo install -m 0600 /dev/null /root/maran-backup.passphrase\nsudo editor /root/maran-backup.passphrase\n```\n\nThe file must be a regular file (not a symlink), owned by root, mode `0600` or `0400`, and hold\none line of **at least 20 characters**. Anything else is refused before anything is written. The\npassphrase is never passed on the command line or in the environment.\n\nKeep a copy of the passphrase somewhere other than the server and other than where the archives go.\nWithout it, nobody can open an archive, including you.\n\n## Take a backup\n\n```bash\nsudo /usr/local/sbin/maran panel-backup --passphrase-file /root/maran-backup.passphrase\n```\n\nIt writes `maran-panel-backup-\u003CUTC time>-\u003Cpid>.tar.gpg`, mode `0600`, into `/root` and prints its\npath. `--out DIR` chooses another directory: an absolute path, owned by root and not writable by\ngroup or others. The panel keeps running while the backup is taken. A failed run leaves no\npartial file behind.\n\nCopy the archive off the server. **Whoever holds the archive and the passphrase holds the panel.**\n\n## What the archive contains\n\n| Part | Restored by `panel-restore` |\n|---|---|\n| The panel database, every schema | yes |\n| `Security__EncryptionKey` and `Jwt__SigningKey` from `/etc/maran/panel.env` | yes |\n| `/var/lib/maran/licence.json` | yes |\n| The rest of `/etc/maran` and `/var/lib/maran` (the panel's TLS key, rendered configs, ACME material) | no, inside the archive for manual use |\n\nEverything else in `panel.env` (the host name, ssh ports, the web server's uid) describes the server\nit is on, so a restore keeps what the new install wrote.\n\nThe archive is encrypted with gpg (AES-256) with integrity protection. A changed or truncated\narchive is refused and never restored.\n\n## Restore onto a clean server\n\n1. Install Maran on the new server, the same release as the backup or a newer one. Do not create an\n   administrator in the browser.\n2. Copy the archive to the new server, owned by root, and recreate the passphrase file there.\n3. Restore:\n\n   ```bash\n   sudo /usr/local/sbin/maran panel-restore --passphrase-file /root/maran-backup.passphrase \\\n     --replace-this-panel /root/maran-panel-backup-20261101T120000Z-4242.tar.gpg\n   ```\n\n4. Sign in with an administrator of the old panel. Every session from the old server has ended.\n5. Restore customers' files, sites and databases from the account backups. A panel backup holds\n   the panel's records of them, not their contents.\n\n### The order a restore follows\n\n1. Decrypt and check the archive and its format version.\n2. Check the two keys in the archived `panel.env`.\n3. Stop the panel.\n4. Replace the database in **one transaction**.\n5. Write the two keys into this server's `panel.env`.\n6. Put the licence back.\n7. Apply this release's migrations.\n8. Start the panel.\n\nIf the database replacement fails, its transaction rolls back and the database stays as the install\nleft it. If anything fails after the panel has been stopped, the panel is started again.\n\n### What it refuses\n\n- running without `--replace-this-panel`, because a restore replaces this panel's database and keys;\n- a passphrase file that fails the rules above;\n- an archive that is not an absolute path, not a regular file, or not owned by root;\n- a server with no `/etc/maran/panel.env` (install Maran first);\n- a wrong passphrase or a damaged archive, before anything changes;\n- an archive format this release does not restore;\n- a second backup or restore while one is already running.\n\nNothing from the archive is executed. Only the named files are taken out of it, and the keys are\nchecked before they are written.\n\n## Schedule it, keep a few, send a copy off the server\n\nScheduling, retention and the S3 upload are not in 1.0.0-beta.4. They arrive with the next release.\nOn 1.0.0-beta.4, run `maran panel-backup` from root's crontab and copy the file with your own\ntooling.\n\nFrom the next release the installer puts the timer and its service on the server but never turns\nthem on. You write a settings file first:\n\n```bash\nsudo install -d -m 0700 /etc/maran-backup\nsudo install -m 0600 /dev/null /etc/maran-backup/passphrase\nsudo editor /etc/maran-backup/passphrase\nsudo install -m 0600 /usr/local/maran/cli/panel-backup.conf.example /etc/maran/panel-backup.conf\nsudo editor /etc/maran/panel-backup.conf\nsudo /usr/local/sbin/maran panel-backup-schedule enable\n```\n\n`/etc/maran/panel-backup.conf` is data, not a shell script: one `KEY=VALUE` per line, no quotes, no\nspaces, an unknown or repeated key is refused. It must be owned by root with mode `0600`. It holds\nno secret. It only names the files that do:\n\n| Key | Meaning |\n|---|---|\n| `PASSPHRASE_FILE` | Required. The passphrase file, with the same rules as above. |\n| `OUT_DIR` | Where archives are written. Default `/var/backups/maran-panel`, which the installer creates for root only. Another directory must exist first (root-owned, mode `0700`). |\n| `KEEP` | How many archives to keep, 1 to 365. Default 14. |\n| `SCHEDULE` | When to run, as a systemd calendar time such as `*-*-* 02:30:00` (the default, every day) or `Sun *-*-* 03:00:00`; `hourly`, `daily`, `weekly` and `monthly` also work. The timer adds up to 15 minutes of random delay. |\n| `S3_ENDPOINT`, `S3_BUCKET`, `S3_REGION`, `S3_ACCESS_KEY_ID_FILE`, `S3_SECRET_FILE`, `S3_PREFIX` | Optional upload. Set all of them except `S3_PREFIX` (an optional folder in the bucket), or none. The two credential files hold one value each. |\n\nKeep the passphrase file and the S3 credential files outside `/root` and `/home`, for example in\n`/etc/maran-backup` (root-owned, mode `0700`, each file `0600`). The scheduled job cannot see those\ntwo trees, and `enable` refuses a path under them. Do not keep them under `/etc/maran` either: that\ndirectory is inside the archive, and a passphrase stored in the archive it protects protects\nnothing.\n\n`enable` checks the file and the schedule, then starts the timer. If anything is wrong it names the\nfirst problem and changes nothing. Afterwards:\n\n```bash\nsudo /usr/local/sbin/maran panel-backup-schedule status\nsudo /usr/local/sbin/maran panel-backup-schedule disable\n```\n\n`status` shows whether the timer is enabled and active, its next and last run, and how the last run\nended. `disable` stops the timer and leaves your settings and every archive where they are.\n\nEach run is the same backup as the manual one, taken by the timer as root. A machine that was off at\nthe scheduled time takes its backup when it next starts. Then, in this order:\n\n1. **Retention.** Only after the new archive exists, the newest `KEEP` are kept. Older ones are\n   removed from `OUT_DIR`, and only files whose whole name is `maran-panel-backup-\u003CUTC time>-\u003Cpid>.tar.gpg`\n   and that are regular files. Anything else in the directory is left alone. Retention never touches\n   copies in S3.\n2. **Upload**, only if `S3_ENDPOINT` is set. The already-encrypted `.tar.gpg` file is sent over\n   HTTPS (TLS 1.2 or newer, no redirects, certificates always checked), and the upload counts as\n   done only when the stored object has the same size as the local file. A network error or a 5xx\n   is tried three times, ten seconds apart. The credentials are never put on a command line or in\n   the log.\n\nIf retention or the upload fails, the archive stays on the server and the run is reported as failed\n(`systemctl status maran-panel-backup.service`). Each run also leaves one line in the system journal\nunder the `maran-cli` tag, with the outcome and nothing else. Uninstalling Maran removes the timer\nand never the archives.\n\nTo restore from an off-site copy, download the `.tar.gpg` file to the new server, owned by root, and\nfollow [Restore onto a clean server](#restore-onto-a-clean-server). The passphrase is still the one\nthat encrypted it.\n\n## Limitations\n\n- Retention, the schedule and the upload work from the next release, as described above. The upload\n  speaks the S3 API to an endpoint you name, over HTTPS only. There is no command that fetches an\n  archive back from S3: download it with your own tooling.\n- Restoring an archive from a **newer** release onto an older install is not refused by the\n  command. Install the same release or a newer one first.\n- A licence bound to the old server may need to be re-issued for the new one.\n- The panel's TLS certificate, rendered configs and ACME material are not put back automatically;\n  take them from the archive by hand if you need them.\n- If the server loses power during a backup, the unencrypted staging copy stays in a root-only\n  directory until the next run of either command clears it.\n",{"title":81,"description":1205},"Back up and restore the panel itself","en/docs/panel-backup","ss99XmMQzRs8TXHKe2K8UEnv9CWm1sWQg9Pbgj-pP_8",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":1215},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"14\" height=\"14\" x=\"8\" y=\"8\" rx=\"2\" ry=\"2\"/>\u003Cpath d=\"M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2\"/>\u003C/g>",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":1217},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71\"/>\u003Cpath d=\"M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71\"/>\u003C/g>",1793873016534]