From 34840a8d8d52caa00907169d08f8b66cf5a04aa3 Mon Sep 17 00:00:00 2001 From: Vitalii Koshura Date: Mon, 20 Feb 2023 11:41:46 +0100 Subject: [PATCH] Update HtmlOps.md file Signed-off-by: Vitalii Koshura --- HtmlOps.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/HtmlOps.md b/HtmlOps.md index 9a37fea..79d026c 100644 --- a/HtmlOps.md +++ b/HtmlOps.md @@ -1,7 +1,8 @@ -[[PageOutline]] +# Administrative web interfaces + # Server status page -Each project has a *server status page* (project_url/server_status.php). +Each project has a **server status page** (project_url/server_status.php). This page, which is visible to the public, provides a "dashboard" for the project's server. It shows: @@ -14,7 +15,7 @@ It shows: # Project management page -Each project also has an *project management* web page, +Each project also has an **project management** web page, not visible to the public, that lets project administrators * Browse the database @@ -29,29 +30,29 @@ not visible to the public, that lets project administrators * Browse stripcharts * Browse log files -If your project's URL is *http://a.b.c/test*, -then the URL of the project management page is *http://a.b.c/test_ops*. -The directory containing the admin pages is *~/projects/test/html/ops/*. +If your project's URL is **http://a.b.c/test**, +then the URL of the project management page is **http://a.b.c/test_ops**. +The directory containing the admin pages is **~/projects/test/html/ops/**. Because the page lets you do things like see user email addresses, it's extremely important that it be secure. There are two levels of protection: -## Protection by .htaccess +# Protection by .htaccess -When a project is created, a file *html/ops/.htaccess* is created +When a project is created, a file **html/ops/.htaccess** is created that disallows access to the project management page. -You can use *htpasswd_' to create a '_.htpasswd* file containing +You can use **htpasswd** to create a **.htpasswd** file containing credentials for yourself: - - htpasswd -c .htpasswd username - +``` +htpasswd -c .htpasswd username +``` -## Project-defined protection policy +# Project-defined protection policy -The config file *html/project/project.inc* -can specify a function *auth_ops()* that defines +The config file **html/project/project.inc** +can specify a function **auth_ops()** that defines a project-specific policy for protecting the project management page. Possible policies: @@ -60,10 +61,10 @@ Possible policies: * Access only from specific IP addresses. * Any other policy you can think of. -Some examples are given in the function *auth_ops_example()* in the default config file. +Some examples are given in the function **auth_ops_example()** in the default config file. -## Customizing the project management page +# Customizing the project management page You can add your own content to the project management page by defining a function -*admin_index_extra()* in your html/project/project.inc. -Whatever text this function outputs will be shown at the top of the page. \ No newline at end of file +**admin_index_extra()** in your html/project/project.inc. +Whatever text this function outputs will be shown at the top of the page.