[{"data":1,"prerenderedAt":805},["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/monitoring":469,"i-lucide:link":803},[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":86,"body":472,"description":794,"extension":795,"icon":89,"meta":796,"navigation":110,"order":88,"path":797,"rawbody":798,"section":28,"seo":799,"seoTitle":800,"stem":801,"__hash__":802},"docsEn/en/docs/monitoring.md",{"type":473,"value":474,"toc":785},"minimark",[475,484,487,490,530,533,535,538,555,583,585,592,659,671,674,677,708,710,719,736,756,759,761,776,778],[476,477,478,479,483],"p",{},"Every sign-in lands on the dashboard, ",[480,481,482],"strong",{},"System status",". It answers three questions on one screen: what\nthe server is doing, what is on it and what needs a decision.",[485,486,271],"h2",{"id":272},[476,488,489],{},"For an administrator the page has these parts:",[491,492,493,500,506,512,518,524],"ul",{},[494,495,496,499],"li",{},[480,497,498],{},"Right now",": processor, memory and disk in use, and the load average over 1, 5 and 15 minutes,\nread live from the server agent.",[494,501,502,505],{},[480,503,504],{},"Services",": whether the web server, PHP-FPM, the database server, the FTP server, cron and SSH\nare running.",[494,507,508,511],{},[480,509,510],{},"On this server",": how many accounts, sites and databases it holds.",[494,513,514,517],{},[480,515,516],{},"Needs attention",": certificates expiring soon, backups that failed, background tasks that\nfailed, addresses the firewall has banned and a server clock that is not synchronised.",[494,519,520,523],{},[480,521,522],{},"Latest activity",": the five newest entries of the audit journal, with a link to the whole\njournal.",[494,525,526,529],{},[480,527,528],{},"Quick actions",": create an account, add a site, create a database, open the backups.",[476,531,532],{},"A customer sees their own account instead: links to their account, sites, databases and backups.\nNone of the server-wide figures is sent to a customer.",[485,534,274],{"id":275},[476,536,537],{},"The dashboard collects its parts from several modules, and any one of them can fail to answer. A\npart that could not be read is never shown as an empty list or a zero. \"0 backups failed\"\nand \"Nothing needs attention\" would be claims the panel could not back up.",[491,539,540,547,552],{},[494,541,542,543,546],{},"A count it could not take reads ",[480,544,545],{},"Unavailable",".",[494,548,549,551],{},[480,550,516],{}," names each source it could not check (\"Backups could not be checked\") and\nshows \"Nothing needs attention\" only when every source was read.",[494,553,554],{},"The live reading, the services and the latest activity each say in their own card that they could\nnot be read. They do not disappear.",[476,556,557,558,562,563,566,567,570,571,574,575,578,579,582],{},"For integrations, ",[559,560,561],"code",{},"GET /api/v1/dashboard"," sends every section as ",[559,564,565],{},"{\"state\":\"loaded\",\"data\":…}"," or\n",[559,568,569],{},"{\"state\":\"unavailable\"}",". The response says whom it was built for in ",[559,572,573],{},"audience",", either\n",[559,576,577],{},"administrator"," or ",[559,580,581],{},"customer","; a customer's response carries no sections at all.",[485,584,277],{"id":278},[476,586,587,588,591],{},"The dashboard's disk tile and the disk card under ",[480,589,590],{},"Monitoring"," split the root filesystem into\nthree parts in one bar. The three always add up to the size of the disk:",[593,594,595,614],"table",{},[596,597,598],"thead",{},[599,600,601,605,608],"tr",{},[602,603,604],"th",{},"Figure",[602,606,607],{},"What it is",[602,609,610,613],{},[559,611,612],{},"df"," column",[615,616,617,631,646],"tbody",{},[599,618,619,623,626],{},[620,621,622],"td",{},"In use",[620,624,625],{},"the space the filesystem counts as occupied",[620,627,628],{},[559,629,630],{},"Used",[599,632,633,636,639],{},[620,634,635],{},"Reserved for the system",[620,637,638],{},"free space only root may write: 5% of an ext4 filesystem by default, 0 on xfs",[620,640,641,642,645],{},"none (",[559,643,644],{},"Size - Used - Avail",")",[599,647,648,651,654],{},[620,649,650],{},"Available",[620,652,653],{},"what the hosting accounts can still write",[620,655,656],{},[559,657,658],{},"Avail",[476,660,661,662,664,665,667,668,670],{},"Earlier releases called \"capacity minus available\" the space in use. That counted the reserve as\nused: on a 97.9 GiB ext4 disk the panel read 12.7 GiB where ",[559,663,612],{}," said 7.7 GiB. ",[480,666,622],{}," is now\nexactly ",[559,669,612],{},"'s figure.",[476,672,673],{},"The disk chart plots the same \"in use\" figure. Readings taken before the update stored the old\nfigure, so they show as a gap until they leave the seven-day history.",[476,675,676],{},"The disk-full alert still counts the reserve as full. It fires when the accounts run out of room,\nbecause at that moment every account's write fails even though \"in use\" alone still reads about 95%.",[476,678,557,679,682,683,686,687,690,691,693,694,696,697,700,701,704,705,546],{},[559,680,681],{},"GET /api/v1/monitoring/metrics"," and the dashboard's ",[559,684,685],{},"resources"," carry\n",[559,688,689],{},"diskUsedBytes"," (",[559,692,612],{},"'s ",[559,695,630],{},"), ",[559,698,699],{},"diskReservedBytes",", ",[559,702,703],{},"diskAvailableBytes"," and ",[559,706,707],{},"diskTotalBytes",[485,709,280],{"id":281},[476,711,712,713,715,716,718],{},"The table under ",[480,714,590],{}," → ",[480,717,280],{}," sets each account's use against its plan's\nallowance. A row carries one of three badges when the allowance is not a live limit:",[491,720,721,727,733],{},[494,722,723,726],{},[480,724,725],{},"Not enforced",": the filesystem holding the homes cannot back the allowance with a disk limit, and\nthe row says why (the filesystem has no quota accounting, or accounting is not switched on).",[494,728,729,732],{},[480,730,731],{},"Not checked",": the server did not answer whether the allowance can be enforced, so the panel does\nnot say either way. Try again shortly; if it persists, check that the agent is running.",[494,734,735],{},"No badge: the allowance is enforced by the kernel.",[476,737,738,739,742,743,746,747,700,750,578,753,546],{},"For integrations the same three cases are the ",[559,740,741],{},"backing"," of each row of\n",[559,744,745],{},"GET /api/v1/monitoring/accounts-disk",": ",[559,748,749],{},"enforced",[559,751,752],{},"notEnforced",[559,754,755],{},"unmeasured",[476,757,758],{},"An earlier release showed \"Not checked\" rows as \"Not enforced\", which told an operator the allowance\nwas not held, when in fact nobody had asked.",[485,760,283],{"id":284},[476,762,763,764,715,767,770,771,775],{},"Monitoring alerts and backup alerts are mailed to the address set under ",[480,765,766],{},"Outgoing mail",[480,768,769],{},"Send\nalerts to",", through the same mail server. Both kinds go through one shared path. Each is written\nto the audit journal as \"Alert raised\", and with no alert address configured the journal also records\n\"Mail skipped: no SMTP settings\". What the backups mail about is on the\n",[772,773,774],"a",{"href":67},"file transfer and backups"," page.",[485,777,286],{"id":287},[476,779,780,715,782,784],{},[480,781,590],{},[480,783,286],{}," sets how much the panel writes to its log without a restart,\nfrom Verbose to Fatal. The level is the panel's own. The libraries it is built on (the message bus,\nthe database driver, the HTTP client and the web platform) are always written at Warning or above,\nso choosing Verbose makes the panel log more but does not write every query or message into the\njournal, and choosing Error silences their warnings too. The platform's start-up and shutdown lines\nstay at Information. No level makes the panel log a password, a key or a token.",{"title":786,"searchDepth":15,"depth":15,"links":787},"",[788,789,790,791,792,793],{"id":272,"depth":15,"text":271},{"id":275,"depth":15,"text":274},{"id":278,"depth":15,"text":277},{"id":281,"depth":15,"text":280},{"id":284,"depth":15,"text":283},{"id":287,"depth":15,"text":286},"What the landing page shows after sign-in, how it says a part could not be read, and the three disk figures that always add up to the size of the disk.","md",{},"/en/docs/monitoring","---\ntitle: Dashboard and monitoring\ndescription: What the landing page shows after sign-in, how it says a part could not be read, and the three disk figures that always add up to the size of the disk.\nseoTitle: 'Dashboard and monitoring of a server'\nsection: How it works\norder: 13\nicon: lucide:activity\n---\n\nEvery sign-in lands on the dashboard, **System status**. It answers three questions on one screen: what\nthe server is doing, what is on it and what needs a decision.\n\n## What the dashboard shows\n\nFor an administrator the page has these parts:\n\n- **Right now**: processor, memory and disk in use, and the load average over 1, 5 and 15 minutes,\n  read live from the server agent.\n- **Services**: whether the web server, PHP-FPM, the database server, the FTP server, cron and SSH\n  are running.\n- **On this server**: how many accounts, sites and databases it holds.\n- **Needs attention**: certificates expiring soon, backups that failed, background tasks that\n  failed, addresses the firewall has banned and a server clock that is not synchronised.\n- **Latest activity**: the five newest entries of the audit journal, with a link to the whole\n  journal.\n- **Quick actions**: create an account, add a site, create a database, open the backups.\n\nA customer sees their own account instead: links to their account, sites, databases and backups.\nNone of the server-wide figures is sent to a customer.\n\n## A part that could not be read says so\n\nThe dashboard collects its parts from several modules, and any one of them can fail to answer. A\npart that could not be read is never shown as an empty list or a zero. \"0 backups failed\"\nand \"Nothing needs attention\" would be claims the panel could not back up.\n\n- A count it could not take reads **Unavailable**.\n- **Needs attention** names each source it could not check (\"Backups could not be checked\") and\n  shows \"Nothing needs attention\" only when every source was read.\n- The live reading, the services and the latest activity each say in their own card that they could\n  not be read. They do not disappear.\n\nFor integrations, `GET /api/v1/dashboard` sends every section as `{\"state\":\"loaded\",\"data\":…}` or\n`{\"state\":\"unavailable\"}`. The response says whom it was built for in `audience`, either\n`administrator` or `customer`; a customer's response carries no sections at all.\n\n## The disk: in use, reserved, available\n\nThe dashboard's disk tile and the disk card under **Monitoring** split the root filesystem into\nthree parts in one bar. The three always add up to the size of the disk:\n\n| Figure | What it is | `df` column |\n| --- | --- | --- |\n| In use | the space the filesystem counts as occupied | `Used` |\n| Reserved for the system | free space only root may write: 5% of an ext4 filesystem by default, 0 on xfs | none (`Size - Used - Avail`) |\n| Available | what the hosting accounts can still write | `Avail` |\n\nEarlier releases called \"capacity minus available\" the space in use. That counted the reserve as\nused: on a 97.9 GiB ext4 disk the panel read 12.7 GiB where `df` said 7.7 GiB. **In use** is now\nexactly `df`'s figure.\n\nThe disk chart plots the same \"in use\" figure. Readings taken before the update stored the old\nfigure, so they show as a gap until they leave the seven-day history.\n\nThe disk-full alert still counts the reserve as full. It fires when the accounts run out of room,\nbecause at that moment every account's write fails even though \"in use\" alone still reads about 95%.\n\nFor integrations, `GET /api/v1/monitoring/metrics` and the dashboard's `resources` carry\n`diskUsedBytes` (`df`'s `Used`), `diskReservedBytes`, `diskAvailableBytes` and `diskTotalBytes`.\n\n## Disk use by account\n\nThe table under **Monitoring** → **Disk use by account** sets each account's use against its plan's\nallowance. A row carries one of three badges when the allowance is not a live limit:\n\n- **Not enforced**: the filesystem holding the homes cannot back the allowance with a disk limit, and\n  the row says why (the filesystem has no quota accounting, or accounting is not switched on).\n- **Not checked**: the server did not answer whether the allowance can be enforced, so the panel does\n  not say either way. Try again shortly; if it persists, check that the agent is running.\n- No badge: the allowance is enforced by the kernel.\n\nFor integrations the same three cases are the `backing` of each row of\n`GET /api/v1/monitoring/accounts-disk`: `enforced`, `notEnforced` or `unmeasured`.\n\nAn earlier release showed \"Not checked\" rows as \"Not enforced\", which told an operator the allowance\nwas not held, when in fact nobody had asked.\n\n## Alerts reach the operator by mail\n\nMonitoring alerts and backup alerts are mailed to the address set under **Outgoing mail** → **Send\nalerts to**, through the same mail server. Both kinds go through one shared path. Each is written\nto the audit journal as \"Alert raised\", and with no alert address configured the journal also records\n\"Mail skipped: no SMTP settings\". What the backups mail about is on the\n[file transfer and backups](/docs/file-transfer) page.\n\n## Panel log level\n\n**Monitoring** → **Panel log level** sets how much the panel writes to its log without a restart,\nfrom Verbose to Fatal. The level is the panel's own. The libraries it is built on (the message bus,\nthe database driver, the HTTP client and the web platform) are always written at Warning or above,\nso choosing Verbose makes the panel log more but does not write every query or message into the\njournal, and choosing Error silences their warnings too. The platform's start-up and shutdown lines\nstay at Information. No level makes the panel log a password, a key or a token.\n",{"title":86,"description":794},"Dashboard and monitoring of a server","en/docs/monitoring","EhIppsafsAbegdfRiT_vOL8EDQf4NxIkOqQilUfLYQY",{"left":96,"top":96,"width":97,"height":97,"rotate":96,"vFlip":98,"hFlip":98,"body":804},"\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>",1793873016421]