Update HtmlOps.md file

Signed-off-by: Vitalii Koshura <lestat.de.lionkur@gmail.com>
Vitalii Koshura 2023-02-20 11:41:46 +01:00
parent 8b83f0d211
commit 34840a8d8d
No known key found for this signature in database
GPG Key ID: CE0DB1726070A5A3
1 changed files with 20 additions and 19 deletions

@ -1,7 +1,8 @@
[[PageOutline]] # Administrative web interfaces
# Server status page # 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, This page, which is visible to the public,
provides a "dashboard" for the project's server. provides a "dashboard" for the project's server.
It shows: It shows:
@ -14,7 +15,7 @@ It shows:
# Project management page # 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 not visible to the public, that lets project administrators
* Browse the database * Browse the database
@ -29,29 +30,29 @@ not visible to the public, that lets project administrators
* Browse stripcharts * Browse stripcharts
* Browse log files * Browse log files
If your project's URL is *http://a.b.c/test*, 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*. 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/*. The directory containing the admin pages is **~/projects/test/html/ops/**.
Because the page lets you do things like Because the page lets you do things like
see user email addresses, it's extremely important that it be secure. see user email addresses, it's extremely important that it be secure.
There are two levels of protection: 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. 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: 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. a project-specific policy for protecting the project management page.
Possible policies: Possible policies:
@ -60,10 +61,10 @@ Possible policies:
* Access only from specific IP addresses. * Access only from specific IP addresses.
* Any other policy you can think of. * 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 You can add your own content to the project management page by defining a function
*admin_index_extra()* in your html/project/project.inc. **admin_index_extra()** in your html/project/project.inc.
Whatever text this function outputs will be shown at the top of the page. Whatever text this function outputs will be shown at the top of the page.