Skip to content
Merged
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
82 changes: 82 additions & 0 deletions docs/features/folders/create-a-new-folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# How to Create a New Folder

1. Log into [HexOS deck](deck.hexos.com)
2. Move to the Folders section in the side menu
3. Select the **New Folder** button

<img width="868" height="639" alt="click-add-new-folder" src="https://github.com/user-attachments/assets/c0ca6cef-3829-4127-835c-df7f556cd6f3" />

This will bring up the **Create Folder** dialogue

<img width="1865" height="1133" alt="create-folder-1" src="https://github.com/user-attachments/assets/200690f5-1907-4ed2-803d-491da282ba81" />

## General

### Folder Name
- Select a folder name.
> **Note:** Folder name cannot be modified after folder creation.

### Location
- Select the pool where you would like your folder to be in.
- If you only have one pool then it will automatically be selected for you.
> **Note:** Folder location cannot be modified after folder creation.

<img width="1246" height="396" alt="location" src="https://github.com/user-attachments/assets/75ce2a6e-2977-4ac5-b9bd-1012e3dbcb8d" />

## Access <small>(optional)</small>
In the **Access** section you can select which users have access to this folder and which permissions they are granted. This is covered in more detail in the [Folder Permissions section](/folders/##folder-permissions).

<img width="1279" height="661" alt="access" src="https://github.com/user-attachments/assets/f9a764c2-d0d0-4ad4-ad69-896838cb1492" />

In this example a user has been selected and given permission only to view the files.

<img width="1279" height="661" alt="private-view-only" src="https://github.com/user-attachments/assets/900e22fc-e5e1-4e78-9d85-462a06a71ae0" />

## Options

### Folder storage limit <small>(optional)</small>
In this section you can set a maximum amount of disk space the folder may use. This helps manage disk usage when multiple people or applications share your server.

### Backup <small>(optional)</small>
You can Enable Time Machine by selecting the checkbox. Enabling this feature sets up the folder with the proper configuration for Apple's Time Machine backup system.

<img width="1714" height="614" alt="options" src="https://github.com/user-attachments/assets/5c8d86a1-8b0f-4771-8815-172660938b74" />

## Encryption <small>(optional)</small>
You can optionally enable encryption on folders you create. [Read about encrypted folders here.](/features/folders/index.md#encrypted-folders)
- The passphrase must be at least 8 characters long.
- Encryption is required for backing up a folder to another server.
- <span style="color: red;">Data from encrypted folders cannot be recovered if the passphrase is lost.</span>

<img width="1814" height="1084" alt="encryption" src="https://github.com/user-attachments/assets/51155ee1-219e-4850-8ac2-897dfde2b66f" />

>**Important:** Encryption can only be enabled during folder creation and cannot be disabled once the folder is created, nor can the passphrase be changed.

## Finalizing New Folder Creation

<img width="1841" height="1160" alt="overview" src="https://github.com/user-attachments/assets/8fb0e6b6-a0ab-42a2-a0cb-9cd1e969b8bc" />

After configuring all fo the folder settings you will see the overview of your choices.

If you wish to adjust any settings, select the back button and edit the settings. When you are ready select **Create** and the folder will be created. When a folder is created you will see it on the **Folders** screen.

## Editing folder settings

To edit the settings of a folder go to the Folders screen and select the folder you wish to edit.

<img width="847" height="541" alt="click-folder" src="https://github.com/user-attachments/assets/def9039e-0043-4b22-a404-5f3c021f50ec" />

Then select **Edit**

<img width="1401" height="973" alt="Screenshot From 2025-10-03 14-13-34" src="https://github.com/user-attachments/assets/80689a91-4de7-413a-824f-0b1c0b3f9836" />

Folders cannot be renamed and encryption settings can’t be modified after folder creation. <br>The edit dialogue shows you what may be edited.

<img width="1814" height="1084" alt="edit" src="https://github.com/user-attachments/assets/78b8dadb-ed24-4f1a-a5a4-35d970845af2" />

In this example, a new user has been added and the folder permissions are set to allow the new user to view the Recipes folder.

<img width="1814" height="1084" alt="save-edit" src="https://github.com/user-attachments/assets/87da2a21-6c6a-4d5c-b9a3-0d0a2351a4c2" />



61 changes: 61 additions & 0 deletions docs/features/folders/create-a-new-user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# How to create a new user

If you want to share selected folders or files with someone who has access to your network, you can do this is by adding a new user in HexOS.

- You can select the folders each user can access.
- You can select if users are allowed to view files or edit them as well.
- User cannot access any other part of your server they aren't given access to.
- Users created here are unable to view HexOS Deck or access applications

## Adding a new user

1. Open [HexOS deck](https://deck.hexos.com)
2. Select the **Folders** screen
3. Select **Add new** under the **Users** section.
> **Note:** The admin account doesn't show up in this list of users


<img width="2227" height="1248" alt="add-new-user" src="https://github.com/user-attachments/assets/bea6021f-5538-4cc6-8d15-01890dcaffb1" />


1. Select a **Username** and **Password**
2. Select **Add account**

<img width="1200" height="947" alt="set-username-and-password" src="https://github.com/user-attachments/assets/50947bce-082f-4c68-bf76-e5d7c0204db9" />

The user will then appear in the deck under the **Users** section of the **Folders** screen. This might take a few moments.

<img width="1374" height="580" alt="user-is-there" src="https://github.com/user-attachments/assets/9d6aa23b-673f-475e-bc5a-df69200f113c" />


## Changing the password of a user

You can change the username or set a new password for an existing user.
1. Open [HexOS deck](https://deck.hexos.com)
2. Select the **Folders** screen
3. Select the user you wish to edit

<img width="806" height="387" alt="edit-user-1" src="https://github.com/user-attachments/assets/fe56752f-1f64-4d01-90df-7ddf9fef10fe" />

Select the **Edit** button

<img width="1216" height="762" alt="edit-user-2" src="https://github.com/user-attachments/assets/fb983810-0509-48e2-9775-02f559b1c8c8" />


1. Change the username and set a new password if desired
2. Select **Update account** when you are finished.

<img width="1195" height="962" alt="edit-user-password" src="https://github.com/user-attachments/assets/44b37610-0270-41d3-826b-b5494cd6d36a" />

## How can a user access folders

When you [create](/features/folders/create-a-new-folder) or [edit](/features/folders/create-a-new-folder/#editing-folder-settings) a folder you can choose which users may access the contents and what permissions they have.

You can read about the **Access** settings on the [create a new folder page here.](/features/folders/create-a-new-folder/#access)

The user will need to setup access to the folders on their computer or phone as described in the [how to access folders guide](/folders/how-to-access-folder-contents).

Their device will prompt them for the username and password when they try to access a private folder. They will be able to see other folders and the folder names but the user will only be able to access the folders they have been granted permission to access.



126 changes: 126 additions & 0 deletions docs/features/folders/how-to-access-folder-contents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# How to Access Files and Folders Over the Network

In HexOS, you can [create folders](/features/folders/create-a-new-folder) through the deck, but you can’t add contents to the folders via the deck. <br>
The folder contents are added, viewed and edited from another device *over the network*. This means folders are accessed using a computer, laptop or phone connected to the same network.

This guide will explain how to access a folder on your HexOS server from a variety of other devices.
>Note: Some apps may require different methods to add or view data. In Immich, for example, you upload photos and videos via a web browser.

## Copying the Address of a Folder

1. In the folders screen of your HexOS [deck](https://deck.hexos.com), select on the folder you want to access
2. Select the **Browse** button

<img width="1484" height="1099" alt="browse-button" src="https://github.com/user-attachments/assets/4bc786e3-e672-41b6-9235-fb94c80d6e18" />

You will be given the folder IP address needed to connect to it from other devices on the same network. You can select the Copy button to copy a link and paste it following the instructions below.

<img width="1053" height="608" alt="link-for-browse" src="https://github.com/user-attachments/assets/5cb66e5e-a6de-4f89-b3a3-35b523abd0be" />

You can select Windows or Mac using the dropdown.

<img width="1053" height="608" alt="choose-between-windows-or-mac" src="https://github.com/user-attachments/assets/ee0c6d56-d436-4c23-88a9-7c2d20a7c4d6" />

Changing the Windows/Mac setting doesn't modify the folder, it just provides instructions for the selected operating system.

## Accessing the folder from your device

Here are some examples of how to access the file from various devices. The specific method may vary a little depending on your operating system.

### On Mac

1. Open Finder
2. Select "Go" in the menu bar
3. Select "Connect to Server"
4. Paste the SMB link into the "Server Address" field
5. Select the "Connect" button

### On Windows
1. Open File Explorer
2. On the left side there is a list of folders and locations, select **This PC**

<img width="1070" height="664" alt="this-pc" src="https://github.com/user-attachments/assets/2674928c-adac-4972-ab11-e831c6df0ac9" />

1. Right click for the menu
2. Select **Add a network location**

<img width="561" height="592" alt="add-a-network-location" src="https://github.com/user-attachments/assets/33afaa07-7e69-4bac-9fc4-c6d0009dc312" />

Follow the wizard though by selecting the **Next** button.

<img width="720" height="606" alt="next" src="https://github.com/user-attachments/assets/877a37f5-2df4-4ef4-8bf9-98c790eecec1" />

Select the **Next** button on the **Choose a custom network location** step.

<img width="720" height="606" alt="choose-custom-next" src="https://github.com/user-attachments/assets/183a83a5-755d-46cb-a62d-4e25e1ccff8c" />

Paste the folder address in and select the **Next** button.

<img width="720" height="606" alt="paste-in-address" src="https://github.com/user-attachments/assets/34109dba-a600-49f4-9a32-91698c0604d0" />

You can optionally choose a display name. Select the **Next** button.

<img width="720" height="606" alt="name-it" src="https://github.com/user-attachments/assets/6827c07e-aa33-4557-861d-e4c8f75372bc" />

Then select the **Finish** button.

<img width="720" height="606" alt="finish" src="https://github.com/user-attachments/assets/3e60c006-fd4b-468b-82ac-edcbf83200ee" />

Your folder will now be accessible from your file browser.

If the folder is private you will be asked for a username and password before it will open.

<img width="585" height="558" alt="password" src="https://github.com/user-attachments/assets/2e6459cd-bb4f-45b1-895a-51c9ea0b4a52" />

### On ChromeOS

Open the My Files app.

<img width="653" height="501" alt="my-files" src="https://github.com/user-attachments/assets/7fc60faf-ac38-468e-8988-0c52c4d5b5d3" />

1. On the top right, select the menu button (three vertical dots)
2. Select Services
3. Select SMB File Share

<img width="660" height="595" alt="services-smb-share" src="https://github.com/user-attachments/assets/7e153a65-747b-42c5-bc35-5e0473cdcadb" />

1. Then select a suggested share from the list or manually enter the URL using the given in the windows section "\\\ipaddress\Folder-name"
2. Fill out the password field if required
3. Select **Add**

<img width="673" height="683" alt="smb-share-login" src="https://github.com/user-attachments/assets/e1107dab-088b-448a-898f-433f552b8a25" />

The file will now show in the left hand navigation on My Files

<img width="673" height="683" alt="shortcut-in-my-files" src="https://github.com/user-attachments/assets/ecca25e5-df0f-436b-a5c1-c859439cee4f" />

### On Linux

This varies depending on your linux distro. The url required will likely be similar to the Mac one, with forward slashes (rather than windows and chrome with \\ back slashes). The following example is from Fedora.

1. Open your files app
2. Select **Network**
3. Paste in the folder address

<img width="1483" height="849" alt="paste-in-address-1" src="https://github.com/user-attachments/assets/390cbaff-3e82-43d1-925e-6bead7f143cc" />

1. Fill in the username and password if needed
2. Select **Connect**

<img width="1047" height="957" alt="enter-details" src="https://github.com/user-attachments/assets/3d1d558d-58dc-4e63-8e55-cf98f45a88c4" />

You will now see the folder in your Networks section of your file manager and also as a shortcut at the bottom of the left hand navigation of files

<img width="1514" height="1041" alt="files-shortcut" src="https://github.com/user-attachments/assets/0da3c4b9-90fd-4318-a914-b189e0a54f8f" />

Sometimes the folder may show under **Other locations**

<img width="1212" height="812" alt="other-locations" src="https://github.com/user-attachments/assets/649fb11e-8227-4726-9fff-e8a8fff56643" />

## Android

Guide coming soon

## iOS

Guide coming soon
Loading
Loading