|
| 1 | +--- |
| 2 | +# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de> |
| 3 | +# SPDX-License-Identifier: CC-BY-4.0 |
| 4 | + |
| 5 | +title: Portable Mode |
| 6 | +description: Learn how to use Kando in portable mode. |
| 7 | +sidebar: |
| 8 | + badge: |
| 9 | + text: soon! |
| 10 | + variant: tip |
| 11 | +--- |
| 12 | + |
| 13 | +import { CardGrid, Aside, Tabs, TabItem, Steps, Badge, FileTree } from '@astrojs/starlight/components'; |
| 14 | +import CustomCard from '../../components/CustomCard.astro'; |
| 15 | +import Intro from '../../components/Intro.astro'; |
| 16 | +import { Icon } from 'astro-icon/components'; |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +<Intro> |
| 21 | +Kando can be configured to load and save all its [configuration files](/config-files) in its installation directory. |
| 22 | +In fact, you can set any directory as Kando's configuration directory. |
| 23 | +</Intro> |
| 24 | + |
| 25 | +<Aside type="danger" title="Not available yet!"> |
| 26 | +Portable mode will be available in an upcoming release of Kando. Stay tuned! |
| 27 | +</Aside> |
| 28 | + |
| 29 | +## <Icon name="solar:planet-3-bold-duotone" class="inline-icon" /> Enabling Portable Mode <Badge text="soon!" variant="tip" /> |
| 30 | + |
| 31 | +To enable portable mode, you need to create a `portableMode.json` next to the Kando executable. |
| 32 | +So for instance if you downloaded the Kando zip archive from GitHub and extracted it, you would create the file in the extracted folder. |
| 33 | + |
| 34 | +```json title=portableMode.json |
| 35 | +{ |
| 36 | + // The path to the configuration directory. |
| 37 | + // This can be an absolute path or a path relative to this file. |
| 38 | + "configDirectory": "config" |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +The above example would make Kando load and save its configuration files in a subfolder named `config` next to the executable. |
| 43 | +If you specified an absolute path instead, Kando would use that path. |
| 44 | +This way, you can also use portable mode to load and save the configuration files in any other directory on your system. |
0 commit comments