Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marest94 committed Dec 12, 2023
1 parent 3ab2c7f commit 2f1e2b7
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/advancedConfiguration/auditlogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,6 @@ Content of the file is consisted of json entries.

Trace log file contains logs that can be useful when debugging or investigating what was incorrect and why connector is responding as expected. In cases when connector does not start, or if response is not expected, some rejection message is returned instead any other response, good starting point is to check content of this log file and get information why connector is not responding as expected.

User might try to solve the problem, in most cases problem will be configuration related or that invalid values are passed.
User might try to solve the problem, in most cases problem will be configuration related or that invalid values are passed.

More information about OS logs on Host machine and how to configure it can be found [here](os-logs-configuration.md)
65 changes: 65 additions & 0 deletions doc/advancedConfiguration/os-logs-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@

# OS Log Access Configuration Guide

## For Linux OS

### Prerequisites
- Root or sudo privileges on the Linux system.
- Basic understanding of Linux file system and permissions.

### Steps

1. **Open Terminal**
- Access the terminal on the Linux machine.

2. **Add User to Required Groups**
- Add the user to the `adm` group to allow reading system logs:
```
sudo usermod -a -G adm [username]
```
3. **Set Permissions for Log Files**
- Change permissions of the log files (if necessary) to ensure readability:
```
sudo chmod o+r /var/log/syslog
```
4. **Verify Access**
- Switch to the user account and verify access to the logs:
```
su - [username]
cat /var/log/syslog
```
5. **Review and Confirm**
- Ensure the user can read the necessary logs without issues.
## For Windows OS
### Prerequisites
- Administrative access to the Windows system.
- Basic knowledge of Windows security settings and User Account Control (UAC).
### Steps
1. **Open Local Security Policy**
- Press `Win + R`, type `secpol.msc`, and press Enter.
2. **Navigate to User Rights Assignment**
- In the Local Security Policy window, navigate to: `Security Settings` -> `Local Policies` -> `User Rights Assignment`.
3. **Edit Audit Policy**
- Find and double-click on `Audit logon events`.
- Add the user or group that needs log access.
- Apply the changes.
4. **Grant Access to Event Viewer**
- Right-click on `Start`, and select `Computer Management`.
- Go to `System Tools` -> `Event Viewer`.
- Right-click on `Event Viewer (Local)` and select `Properties`.
- Under the `Security` tab, add the user or group and assign the appropriate permissions.
5. **Review and Apply Settings**
- Confirm all settings are correctly applied.
- Inform the user about the access granted.

0 comments on commit 2f1e2b7

Please sign in to comment.