Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GenQuery2 docs and tweak to syslog docs (main) #278

Merged
merged 2 commits into from
Aug 27, 2024
Merged

GenQuery2 docs and tweak to syslog docs (main) #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9973e18
[#264] Document GenQuery2.
korydraughn Aug 26, 2024
134d9c9
[#281] Remove references to rsyslog under "Getting Started > Running".
korydraughn Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/getting_started/running.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ The iRODS Server can be run in one of three modes:
## Syslog Mode
This mode is the default when operating the iRODS Server.

This mode instructs the server and all of its children to write log messages to the **rsyslog** service running on the same computer.

rsyslog can be configured to write messages locally (the default), remotely, or both.
This mode instructs the server and all of its children to write log messages to **syslog**.

syslog can be configured to write messages locally, remotely, or both.

```bash
$ ./irodsctl start
Expand All @@ -21,7 +20,7 @@ $ ./irodsctl start
Messages can be rotated on a regular basis, most commonly through the **logrotate** service.

## Standard Output Mode
This mode instructs the server and all of its children to write log messages to **stdout** instead of **rsyslog**. This mode can be enabled in two ways.
This mode instructs the server and all of its children to write log messages to **stdout** instead of **syslog**. This mode can be enabled in two ways.

### Option 1 (recommended) - Use the control script in the iRODS service account
```bash
Expand All @@ -36,7 +35,7 @@ $ /usr/sbin/irodsServer -u
Regardless of the method, it is important to remember that once the server has been launched in this mode, the terminal will not return control until the server is shutdown or killed.

## Test Mode
This mode instructs the server to write all log messages to an additional log file. Messages will still be written to stdout or rsyslog depending on how the server was launched. This secondary log file is located at the following location:
This mode instructs the server to write all log messages to an additional log file. Messages will still be written to stdout or syslog depending on how the server was launched. This secondary log file is located at the following location:
```bash
/var/lib/irods/log/test_mode_output.log
```
Expand All @@ -62,4 +61,3 @@ $ ./irodsctl start --test
```bash
$ /usr/sbin/irodsServer -t
```

Loading
Loading