mirror of
				https://github.com/ClusterCockpit/cc-backend
				synced 2025-11-04 01:25:06 +01:00 
			
		
		
		
	@@ -1,7 +1,8 @@
 | 
			
		||||
# Overview
 | 
			
		||||
 | 
			
		||||
Customizing `cc-backend` means changing the logo, legal texts, and the login
 | 
			
		||||
template instead of the placeholders.
 | 
			
		||||
template instead of the placeholders. You can also place a text file in `./var`
 | 
			
		||||
to add dynamic status or notification messages to the clusterCockpit homepage.
 | 
			
		||||
 | 
			
		||||
# Replace legal texts
 | 
			
		||||
 | 
			
		||||
@@ -22,3 +23,7 @@ To change the logo displayed in the navigation bar, you can provide the file
 | 
			
		||||
folder exists and use the images provided there instead of the built-in images.
 | 
			
		||||
You may also place additional images there you use in a custom login template.
 | 
			
		||||
 | 
			
		||||
# Add notification banner on homepage
 | 
			
		||||
To add a notification banner you can add a file `notice.txt` to `./var`. As long
 | 
			
		||||
as this file is present all text in this file is shown in an info banner on the
 | 
			
		||||
homepage.
 | 
			
		||||
 
 | 
			
		||||
@@ -3,11 +3,11 @@
 | 
			
		||||
## Usage
 | 
			
		||||
 | 
			
		||||
* Searchtags are implemented as `type:<query>` search-string
 | 
			
		||||
  * Types `jobId, jobName, projectId, username, name` for roles `admin` and `support`
 | 
			
		||||
  * Types `jobId, jobName, projectId, username, name, arrayJobId` for roles `admin` and `support`
 | 
			
		||||
    * `jobName` is jobName as persisted in `job.meta_data` table-column
 | 
			
		||||
    * `username` is actual account identifier as persisted in `job.user` table-column
 | 
			
		||||
    * `name` is account owners name as persisted in `user.name` table-column
 | 
			
		||||
  * Types `jobId, jobName, projectId` for role `user`
 | 
			
		||||
  * Types `jobId, jobName, projectId, arrayJobId` for role `user`
 | 
			
		||||
  * Examples:
 | 
			
		||||
    * `jobName:myJob12`
 | 
			
		||||
    * `jobId:123456`
 | 
			
		||||
@@ -23,6 +23,7 @@
 | 
			
		||||
    * **Please Note**: Only users with jobs will be shown in table! I.e., Users without jobs will be missing in table. Also, a `Last 30 Days` is active by default and might filter out expected users.
 | 
			
		||||
  * Name: Users-Table
 | 
			
		||||
    * **Please Note**: Only users with jobs will be shown in table! I.e., Users without jobs will be missing in table. Also, a `Last 30 Days` is active by default and might filter out expected users.
 | 
			
		||||
  * ArrayJobId: Job-Table (Lists all Jobs of Queried ArrayJobId)
 | 
			
		||||
  * Best guess search always redirects to Job-Table or `/monitoring/user/$USER` (first username match)
 | 
			
		||||
  * Unprocessable queries will display messages detailing the cause (Info, Warning, Error)
 | 
			
		||||
* Spaces trimmed (both for searchTag and queryString)
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user