Skip to content

Commit ec7004d

Browse files
committed
[irods/irods 8545] Document PID file directory management
1 parent 5ca85f9 commit ec7004d

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

docs/getting_started/running.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,33 @@ Logs are written to syslog. See [The Server Log](../../system_overview/server_lo
1414

1515
### Server PID File
1616

17-
By default, the server writes its process ID (PID) to `/var/run/irods/irods-server.pid`.
17+
By default, the server writes its process ID (PID) to `/run/irods/irods-server.pid`.
1818

19-
Use the `--pid-file` option to specify a different location. This is useful when running multiple iRODS servers on the same host.
19+
Use the `--pid-file` option to specify a different location. This is useful when running multiple iRODS servers on the same host or to get around permission-related problems. For example:
20+
21+
```sh
22+
# Create the directory which will hold the PID file.
23+
mkdir pid_dir
24+
25+
# Always provide the absolute path to the PID file.
26+
irodsServer --pid-file $(pwd)/pid_dir/irods-server.pid -d
27+
```
28+
29+
On an OS where `/run` is mounted as tmpfs, the iRODS PID file directory (`/run/irods`) may not persist across reboots. Administrators can resolve the problem through the use of a service manager (e.g. systemd), a tmpfiles configuration, or the `--pid-file` option.
30+
31+
!!! Warning
32+
These approaches are NOT mutually exclusive. Care must be taken when using a service manager and tmpfiles configuration for PID file directory management.
33+
34+
See [Managing iRODS via the Service Manager](#managing-irods-via-the-service-manager) for information regarding service manager support.
35+
36+
Below is an example tmpfiles configuration. The "User" and "Group" values must match the user and group of the iRODS service account.
37+
38+
```
39+
# Create the irods location to hold PID files
40+
#
41+
# Type Path Mode User Group
42+
d /run/irods 0755 irods irods
43+
```
2044

2145
## Stopping the Server
2246

0 commit comments

Comments
 (0)