Skip to content

Commit c43443e

Browse files
infeoinfeo
committed
Merge branch 'develop'
2 parents 72d4465 + 3e87939 commit c43443e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+646
-245
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Deploy to GitHub Pages
22

33
on:
44
push:
5-
branches: ["main"]
5+
branches: ["main", "develop"]
66
workflow_dispatch:
77

88
jobs:
@@ -22,25 +22,61 @@ jobs:
2222
cache: 'npm'
2323
- name: Install dependencies
2424
run: npm ci
25-
- name: Build with Docusaurus
25+
- name: Build production
2626
run: npm run build
27-
- name: Upload artifact
27+
- name: Upload Prod Pages artifact
2828
uses: actions/upload-pages-artifact@v3
2929
with:
30+
name: prod-site
31+
path: './build'
32+
- name: Build staging
33+
run: npm run build
34+
env:
35+
SITE_URL: https://docs.staging.cryptomator.org
36+
- name: Add robots.txt for staging
37+
run: 'echo -e "User-agent: *\nDisallow: /" > build/robots.txt'
38+
- name: Upload Staging artifact
39+
uses: actions/upload-artifact@v4
40+
with:
41+
name: staging-site
3042
path: './build'
3143

32-
# DEPLOY
33-
deploy:
34-
name: Deploy to GitHub Pages
44+
# DEPLOY PROD
45+
deploy-prod:
46+
if: github.ref == 'refs/heads/main'
47+
name: Deploy Prod to GitHub Pages
3548
runs-on: ubuntu-latest
3649
needs: [build]
37-
permissions: # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
38-
pages: write # to deploy to Pages
39-
id-token: write # to verify the deployment originates from an appropriate source
50+
permissions:
51+
pages: write
52+
id-token: write
4053
steps:
4154
- name: Deploy to GitHub Pages
4255
id: deployment
43-
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
44-
environment: # Deploy to the github-pages environment
56+
uses: actions/deploy-pages@v4
57+
with:
58+
artifact_name: prod-site
59+
environment:
4560
name: github-pages
4661
url: ${{ steps.deployment.outputs.page_url }}
62+
63+
# DEPLOY STAGING
64+
deploy-staging:
65+
if: github.ref == 'refs/heads/develop'
66+
name: Deploy Staging to GitHub Pages
67+
runs-on: ubuntu-latest
68+
needs: [build]
69+
steps:
70+
- name: Download build
71+
uses: actions/download-artifact@v4
72+
with:
73+
name: staging-site
74+
path: ./public
75+
- name: Deploy to Staging Repository
76+
uses: peaceiris/actions-gh-pages@v3
77+
with:
78+
personal_token: ${{ secrets.CRYPTOBOT_DEPLOY_STAGING_DOCS }}
79+
external_repository: cryptomator/docs-staging
80+
publish_dir: ./public
81+
publish_branch: main
82+
cname: docs.staging.cryptomator.org

‎docs/desktop/adding-vaults.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ sidebar_position: 3
66

77
# Adding Vaults
88

9-
You will be presented with two options when adding a vault:
9+
You will be presented with three options when adding a vault:
1010

1111
1. [`Create New Vault…`](#create-a-new-vault) - Choose this if you wish to create a new vault.
1212
2. [`Open Existing Vault…`](#open-an-existing-vault) - Choose this if you already have a vault and wish to open it.
13+
3. [`Recover Existing Vault…`](/docs/desktop/vault-recovery.md#add-recover-vault) - Choose this if you have a vault with missing configuration files that hasn’t yet been added and you want to restore it.
1314

1415
<Image src="/img/desktop/create-or-open-vault.png" alt="Create a new or open an existing vault" width="762" height="610" />
1516

‎docs/desktop/admin-config.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
id: admin-config
3+
title: Admin Configuration
4+
sidebar_position: 12
5+
---
6+
7+
# Admin Configuration
8+
9+
The admin configuration allows device or system administrators to define environment properties for Cryptomator so it runs in the desired context for all users on a device.
10+
It is a system-level key-value file that persists across updates.
11+
12+
## Location of the Admin Configuration {#location-of-admin-configuration}
13+
14+
:::note
15+
Editing the *admin configuration* may require elevated privileges (i.e. admin or root permissions).
16+
:::
17+
18+
The storage location of the admin configuration file `config.properties` depends on the OS. The following table shows the storage path for each OS:
19+
20+
21+
| OS | Default Path |
22+
| :------ | :----------------------------------------------------------- |
23+
| Windows | `C:\ProgramData\Cryptomator\config.properties` |
24+
| macOS | `/Library/Application Support/Cryptomator/config.properties` |
25+
| Linux | `/etc/cryptomator/config.properties` |
26+
27+
28+
## Editing the Admin Configuration {#editing-the-admin-configuration}
29+
30+
The admin configuration is a simple, UTF-8 encoded key-value file.
31+
Entries are of the form `property-key=property-value`.
32+
33+
:::info
34+
Backward slashes `\` in property values must be escaped with another `\`. For example, setting a value of `C:\Logs\Cryptomator` has to be entered as `C:\\Logs\\Cryptomator`.
35+
:::
36+
37+
**Example:** To allow loading of external plugins, you have to set `cryptomator.pluginDir` to a directory of your choice. If you want to set it to `~/cryptomator/plugins`, the line in the admin file looks like this:
38+
39+
```
40+
cryptomator.pluginDir=@{userhome}/cryptomator/plugins
41+
```
42+
43+
:::warning
44+
After creating/editing the file, ensure correct file access permissions!
45+
46+
We recommend read access for all users, **write access only for system/device admins**.
47+
:::
48+
49+
## Configurable Properties {#configurable-properties}
50+
51+
The following property keys are supported.
52+
53+
| Property Key | Description |
54+
| :------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55+
| `cryptomator.logDir=[DirPath]` | The directory where Cryptomator stores its log files (e.g. application log, migration log). |
56+
| `cryptomator.pluginDir=[DirPath]` | The directory where Cryptomator discovers plugins. |
57+
| `cryptomator.p12Path=[FilePath]` | The path to the device key. |
58+
| `cryptomator.mountPointsDir=[DirPath]` | The directory where Cryptomator mounts vaults if no per-vault location has been set. |
59+
| `cryptomator.disableUpdateCheck=[Boolean]` | Whether to disable automatic update checks (`true`) or allow them (`false`). Defaults to false. |
60+
61+
62+
## Substitutions {#substitutions}
63+
64+
Substitutions are used to dynamically resolve the content of some properties depending on the environment Cryptomator is
65+
started in, e.g. by inserting the path to the user's home folder. They may **only** be used in properties that start
66+
with `cryptomator.` (mind the dot) like `cryptomator.logDir`.
67+
All occurrences of the following substitution keys – in supported properties – are replaced by their respective variable
68+
values:
69+
70+
| Substitution Key | Variable Value |
71+
| :--------------- | :-------------------------------------- |
72+
| `@{appdir}` | The application installation directory. |
73+
| `@{appdata}` | `%APPDATA%` (Windows only). |
74+
| `@{localappdata}`| `%LOCALAPPDATA%` (Windows only). |
75+
| `@{userhome}` | The user's home directory. |
76+
77+
Unknown substitution keys remain unchanged; a key without a value is replaced with an empty string.

0 commit comments

Comments
 (0)