Skip to content

Add description of connection readonly mode #71

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 19 additions & 4 deletions src/content/docs/settings/connection.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
---
title: Connection
title: Connection
---

import { Aside } from '@astrojs/starlight/components';

Multiple connections can be defined and some settings are specific to a connection and can be saved for the connection and later reloaded.

### Read only mode

When checked, you can not change any content on the server, run any actions on the server or open any terminal.
You can only browse the content of the server, and members and streamfiles will always be opened in readonly mode.

<Aside type="note">
This setting can be controlled by the IBM i system administrator in the [system settings](../system/).
</Aside>

<Aside type="danger">
This setting can only protect against changes from Code for IBM i. It will not protect against changes from any other interface or application.

Configuration of IBM i object security on the server is advised!
</Aside>

### Current library

The library which will be set as the current library during compilation.

You can change the current library with the 'Change build library' command (F1 -> Change build library).
You can change the current library with the 'Change Current Library' command in the Command Palette (F1).

### Home Directory

Expand All @@ -20,15 +35,15 @@ Home directory for user. This directory is also the root for the IFS browser.

Temporary library. Stores temporary objects used by Code for i. Will be created automatically if it does not exist. Cannot be QTEMP. Default value is `ILEDITOR`.

<Aside type="danger">
<Aside type="note">
If your IBM i runs replication software, there is no need to replicate the temporary library. Your sysadmin may add it to the list of objects to be ignored.
</Aside>

### Temporary IFS directory

Temporary IFS directory. Stores temporary IFS files used by Code for i. Will be created automatically if it does not exist. Must be in root or QOpenSys filesystem. Default value is `/tmp`.

<Aside type="danger">
<Aside type="note">
If your IBM i runs replication software, there is no need to replicate the temporary directory. Your sysadmin may add it to the list of path to be ignored.
</Aside
>
Expand Down
Binary file modified src/content/docs/settings/settings_json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/content/docs/settings/system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ As of Code for IBM i 2.16.3, the extension supports system-wide settings that ca

All configuration files related to VS Code settings should be stored under `/etc/vscode/` in the IFS.

![](./settings_json.png)

### Code for IBM i settings

![](./settings_json.png)

The path is `/etc/vscode/settings.json`. The top level is a JSON object that can contain different properties. Below is a table for the first level of properties. If sub-properties are not described here, refer to the content assist while working on the file.

| Property | Description |
Expand Down