Skip to content

Commit 5a11068

Browse files
author
Vladimir Kotal
authored
move Messages content to wiki
1 parent f08a97b commit 5a11068

File tree

1 file changed

+1
-63
lines changed

1 file changed

+1
-63
lines changed

README.md

Lines changed: 1 addition & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -81,69 +81,7 @@ as a project.
8181

8282
### 3.2 Messages
8383

84-
Deployed OpenGrok can receive couple of messages through the active socket which
85-
usually listens for the main configuration file. These are used in the web
86-
application and displayed to the users. One can easily notify users about some
87-
important events, for example that the reindex is being in progress and that
88-
the searched information can be inconsistent.
89-
90-
The OpenGrok comes with a tool which allows you to send these messages without
91-
any problem. It is called **Messages** and it is located under the tools directory.
92-
See the file for usage and more information.
93-
94-
#### 3.2.1 Tags
95-
96-
Any message can use tags which makes it more specific for the application.
97-
Messages which tag match some OpenGrok project are considered project specific
98-
and the information contained in them are displayed only for the specific projects.
99-
100-
There is a key tag `main` which is exclusive for displaying
101-
messages on the OpenGrok landing page - like a common information.
102-
103-
#### 3.2.2 Types
104-
105-
Currently supported message types:
106-
107-
1. **NormalMessage (normal)** – this message is designed to display some information in the web application.
108-
Use tags to target a specific project.
109-
110-
2. **AbortMessage (abort)** – this message can delete some already published information in
111-
the web application.
112-
Use tags to restrict the deletion only to specific projects.
113-
114-
3. **StatsMessage (stats)** – this message is designed to retrieve some information from the web application.
115-
116-
The purpose of the message is specified in the text field as one of:
117-
118-
* **reload** – the application reloads the statistics file
119-
and returns the loaded statistics
120-
* **clean** – the application cleans its current statistics
121-
and returns the empty statistics
122-
* **get** – the application returns current statistics
123-
124-
4. **ConfigMessage (config)** – this message performs some configuration communication with the webapp,
125-
depending on tag.
126-
* **setconf** – tag sends config to webapp and requires a file as an argument.
127-
* **getconf** – tag retrieves the configuration from the webapp.
128-
* **set** – tag sets particular configuration option in the webapp.
129-
* **auth** – tag requires "reload" text and
130-
reloads all authorization plugins.
131-
132-
5. **RefreshMesssage (refresh)** – sent at the end of partial reindex to trigger refresh of `SearcherManagers`.
133-
134-
6. **ProjectMessage** – used for adding/deleting projects and partial (per-project) reindex.
135-
136-
* **add** – adds project(s) and its repositories to the configuration.
137-
If the project already exists, refresh list of its repositories.
138-
* **delete** – removes project(s) and its repositores from the configuration.
139-
Also deletes its data under data root (but not the source code).
140-
* **indexed** – mark the project(s) as indexed so it becomes visible in the UI
141-
* **get-repos** – get list of repositories in the form of relative paths to source root for given project(s)
142-
* **get-repos-type** – get repository type(s) for given project(s)
143-
144-
6. **RepositoryMessage** – used for getting repository info.
145-
146-
* **get-repo-type** – get repository type
84+
See https://github.com/oracle/opengrok/wiki/Messages
14785

14886
## 4. OpenGrok install
14987

0 commit comments

Comments
 (0)