From eace9bda6180c1b9b2698e408cf948a81bafc946 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 12:28:05 +0100 Subject: [PATCH 01/14] Folders restructure Made this page an overview. It is designed to help user understand HexOS privacy and data organisation before they learn to make folders/users etc. This page describes: - folder types in detail - folder permission (less detail) - users in detail Separate pages will deal with: - How to create a folder - How to create a user - How to access a folder through the network --- docs/features/folders/index.md | 79 ++++++++++++++++++++-------------- 1 file changed, 47 insertions(+), 32 deletions(-) diff --git a/docs/features/folders/index.md b/docs/features/folders/index.md index c99dd1d5..846a3345 100644 --- a/docs/features/folders/index.md +++ b/docs/features/folders/index.md @@ -1,60 +1,75 @@ # Folders -As with most computer systems, folders are used to store data. Some are automatically created when applications are installed, but users can create folders themselves for sharing files over a network or backing up other devices (Apple Time Machine, Windows Backup, etc). +In HexOS, folders are used to organise your data. Some folders are automatically created when applications are installed, and you can create your own folders too. -## Creating Folders +You might want to make folders for organizing data, sharing files over the network and for backing up other devices with tools like Apple Time Machine and Windows Backup. -When creating a folder, you have several options to configure: +Folders can be password protected or not, and they can be encrypted. You can also create users and decide what they can view and edit. -### Location -Choose which storage pool the folder will be created on. This is especially useful if you have multiple pools with different performance characteristics or purposes. +## The Folders Screen -### Access -Choose who has access to this folder and what permissions they have. We'll cover this in more detail in the Users and Permissions section below. +In your [Deck](https://deck.hexos.com) click Folders on the sidebar menu. On this screen you can see your folders, see system folders, add new folders and add new users too. -### Quota -Set storage limits for individual folders to control how much space they can use. This helps manage disk usage when multiple people or applications share your server. +folders-screen-hexos -### Time Machine -Enable Time Machine support to let your Macs back up directly to this folder. This sets up the folder with the proper configuration for Apple's backup system. +You can’t go into the folders and browse the files from here: this screen only shows the folders and not the contents. [Read about how to access the folder contents here](/folders/how-to-access-files-and-folders-over-the-network) -### Encryption -You can optionally enable encryption on folders you create. Encrypted folders can be "locked" or "unlocked" using a custom passphrase created by the administrator specifically for making the folder accessible. +## Folder Permissions -> **Note:** Encryption can only be enabled during folder creation and cannot be disabled once the folder is created. +It’s a good idea to understand how the privacy and security of your folders is managed. You will be able to choose from the options below when creating a folder. -## How to Access Files and Folders Over the Network +### Folder Types -Each folder has a "Browse" button that shows you exactly how to connect from your device. If you created a private folder you will need to connect to that folder using the associated Users credentials. +#### Public folders -### On Mac -Open Finder, click "Go" in the menu bar, select "Connect to Server". Paste the SMB link into the "Server Address" field and click "Connect". +Anyone can access these folders. This will include all users you have created. This also means that, at least in theory, anyone who has your wifi password can view, edit and delete the contents of the folder. -### On Windows -Open File Explorer, right-click on "This PC", then "Map network drive". Paste the SMB link into the "Folder" field and click "Finish" to connect. +#### Private folders -## Users and Permissions +Only people with a username and password can access these folders. This means by default only the administrator has access. Then, any users that the administrator has created can also be granted access to the private folder. Finally, whether the user may only view or also edit/delete the contents of the folder is defined in the folder settings. -Your account is automatically an administrator, which means you always have full access to all your folders. Creating additional users is optional and comes in handy when you want other people to access specific folders without sharing your admin credentials. +In theory anyone with your wifi password may be able to see the folder name. Also anyone with access to the hard drives in your system may be able to read the data. -### Folder Types -**Public folders:** Anyone can access these folders. +#### Encrypted folders -**Private folders:** Only you and specifically selected users can access these folders. +These folders may be public or private as above. However, when they are set to “locked” by the admin the contents will not be accessible to anyone while the folder remains locked. This means users cannot see the contents of the folder, including the admin, nor can people with the wifi password or with physical access to the hard drives. + +When the folder is “unlocked” again the contents will then be accessible as specified by the other settings and permissions. Encryption is required for backing up a folder to another server. ### Permission Types -You can also give users specific types of access to folders: -**Read access:** Users can view and download files but can't change anything. +You can give users specific types of access to folders: + +#### Read access + +Users can view and download files but can't edit or delete anything. + +#### Write access + +Users can add, modify, and delete files in the folder. Edits and deletes are permanent. + +## Users -**Write access:** Users can add, modify, and delete files in the folder. +Creating additional users is optional. -> **Security Note:** User accounts you create here are just for folder access through network file browsers like Finder or Windows Explorer. They don't give people any control over your server or applications. +Your user account is automatically an administrator: this means you always have full access to all your folders. + +You might wish to create more users if you want other people to access some folders, but you don’t want to share your admin credentials. For example, you want to enable family members to back up their devices without risking them accidentally deleting other items. + +You can select which users have access to folders during creation of folders. This can also be edited later for any folder. + +User accounts you create here are just for folder access through network file browsers like Finder or Windows Explorer. They don't give people any control over your server or applications - only the admin account has this access. ## System Folders When you install apps they automatically create "System Folders" for their data. These appear separately from your personal folders and are managed by the apps themselves. -### What you should know: -- **Reserved names:** Certain folder names like "Downloads" are reserved for system use. If you create a folder with a reserved name, it will automatically appear in System Folders instead of your personal folders -- **Default locations:** These folders have default locations, but you can change where they're created in [locations](/features/settings/#locations) +### Reserved names + +Certain folder names like "Downloads" are reserved for system use. If you create a folder with a reserved name, it will automatically appear in System Folders instead of your personal folders. + +### Default locations + +These folders have default locations, but you can change where they're created in [locations](/features/settings/#locations). + + From 5cffad4c850fa0d0c985328b25ab0ccfbedb7c35 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 12:34:40 +0100 Subject: [PATCH 02/14] Create create-a-new-folder created new page --- docs/features/folders/create-a-new-folder | 44 +++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/features/folders/create-a-new-folder diff --git a/docs/features/folders/create-a-new-folder b/docs/features/folders/create-a-new-folder new file mode 100644 index 00000000..f35412bd --- /dev/null +++ b/docs/features/folders/create-a-new-folder @@ -0,0 +1,44 @@ +# How to Create a New Folder + +To add a new folder, click *New Folder* + +Screenshot 2 + +You will then see the Create Folder dialogue + +Screenshot 3 + +When creating a folder, first give it a name. You then have several other options that you may configure. You can skip this to use the default settings by clicking Continue. + +### Location +This is which pool your folder will be on. If you have only one pool then this will be automatically selected. If you have multiple pools, perhaps with different performance characteristics or purposes, then select one here. + +Screenshot 4 + +### Access +On the menu select Access. Here you can choose who has access to this folder and what permissions they have. This is covered in more detail in the [Folder Permissions section](/folders/##folder-permissions. + +###Options + +#### Quota +On the Options section you can set a maximum amount of disk space the folder may use up. This helps manage disk usage when multiple people or applications share your server. + +#### Time Machine +On this same Options section you can Enable Time Machine. Enabling this feature sets up the folder with the proper configuration for Apple's backup system. + +Screenshot + +### Encryption +You can optionally enable encryption on folders you create. [Read about encrypted folders](LINK)here. The password must be at least 8 characters long. Encryption is required for backing up a folder to another server. + +**Important** Encryption can only be enabled during folder creation and cannot be disabled once the folder is created, nor can the passphrase be changed. + +### Finishing up creating a folder + +Once you have checked your settings press Continue and check the details in the overview. If you wish to change anything, press the back button and edit the settings. When you are ready click Create and then the folder will be created. This may take a few moments. When the folder is created you will see it on the Folders screen. + + +## Editing folder settings + +Only some settings may be changed later. Folders cannot be renamed and encryption settings can’t be changed later.To edit the settings for a folder go to Folders then click the folder you wish to edit. + From 07108c1e7c73e014a75bb7d085a0edbd99a33fb6 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 12:36:10 +0100 Subject: [PATCH 03/14] Update create-a-new-folder --- docs/features/folders/create-a-new-folder | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/features/folders/create-a-new-folder b/docs/features/folders/create-a-new-folder index f35412bd..6ff6eb4b 100644 --- a/docs/features/folders/create-a-new-folder +++ b/docs/features/folders/create-a-new-folder @@ -2,7 +2,6 @@ To add a new folder, click *New Folder* -Screenshot 2 You will then see the Create Folder dialogue From 4751b43c81ac5e15f3e36a6dfe5f973396ad83f8 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 12:49:22 +0100 Subject: [PATCH 04/14] Rename create-a-new-folder to create-a-new-folder.md --- .../folders/{create-a-new-folder => create-a-new-folder.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/features/folders/{create-a-new-folder => create-a-new-folder.md} (100%) diff --git a/docs/features/folders/create-a-new-folder b/docs/features/folders/create-a-new-folder.md similarity index 100% rename from docs/features/folders/create-a-new-folder rename to docs/features/folders/create-a-new-folder.md From 470a69ef009783d4f246fce2ad26378f2ca1878a Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 13:09:30 +0100 Subject: [PATCH 05/14] Update create-a-new-folder.md added guide to: - creating folder - editing folder settings it links back to overview for permissions. Screenshots added --- docs/features/folders/create-a-new-folder.md | 50 ++++++++++++++++---- 1 file changed, 40 insertions(+), 10 deletions(-) diff --git a/docs/features/folders/create-a-new-folder.md b/docs/features/folders/create-a-new-folder.md index 6ff6eb4b..80db6495 100644 --- a/docs/features/folders/create-a-new-folder.md +++ b/docs/features/folders/create-a-new-folder.md @@ -2,22 +2,31 @@ To add a new folder, click *New Folder* +click-add-new-folder -You will then see the Create Folder dialogue +You will then see the *Create Folder* dialogue -Screenshot 3 +create-folder-1 -When creating a folder, first give it a name. You then have several other options that you may configure. You can skip this to use the default settings by clicking Continue. +When creating a folder, first give it a name. You then have several other options that you may configure. You can skip this to use the default settings by clicking *Continue*. ### Location This is which pool your folder will be on. If you have only one pool then this will be automatically selected. If you have multiple pools, perhaps with different performance characteristics or purposes, then select one here. -Screenshot 4 +location ### Access -On the menu select Access. Here you can choose who has access to this folder and what permissions they have. This is covered in more detail in the [Folder Permissions section](/folders/##folder-permissions. +On the menu select *Access*. Here you can choose who has access to this folder and what permissions they have. This is covered in more detail in the [Folder Permissions section](/folders/##folder-permissions). -###Options +access + +In essence, a private folder can only be accessed by the admin and users selected here. A public folder may be accessed by all users, and in theory anyone with your wifi password too. + +In this example a user has been selected and given permission only to view the files. + +private-view-only + +### Options #### Quota On the Options section you can set a maximum amount of disk space the folder may use up. This helps manage disk usage when multiple people or applications share your server. @@ -25,19 +34,40 @@ On the Options section you can set a maximum amount of disk space the folder may #### Time Machine On this same Options section you can Enable Time Machine. Enabling this feature sets up the folder with the proper configuration for Apple's backup system. -Screenshot +options ### Encryption -You can optionally enable encryption on folders you create. [Read about encrypted folders](LINK)here. The password must be at least 8 characters long. Encryption is required for backing up a folder to another server. +You can optionally enable encryption on folders you create. [Read about encrypted folders](/features/folders/index.md#encrypted-folders) here. The password must be at least 8 characters long. Encryption is required for backing up a folder to another server. + +encryption **Important** Encryption can only be enabled during folder creation and cannot be disabled once the folder is created, nor can the passphrase be changed. ### Finishing up creating a folder -Once you have checked your settings press Continue and check the details in the overview. If you wish to change anything, press the back button and edit the settings. When you are ready click Create and then the folder will be created. This may take a few moments. When the folder is created you will see it on the Folders screen. +Once you have checked your settings click *Continue* and check the details in the overview. + +overview +If you wish to change anything, press the back button and edit the settings. When you are ready click *Create* and then the folder will be created. This may take a few moments. When the folder is created you will see it on the *Folders* screen. ## Editing folder settings -Only some settings may be changed later. Folders cannot be renamed and encryption settings can’t be changed later.To edit the settings for a folder go to Folders then click the folder you wish to edit. +To edit the settings for a folder go to Folders then click the folder you wish to edit. + +click-folder + +Then click *Edit* + +Screenshot From 2025-10-03 14-13-34 + +Only some settings may be changed later. Folders cannot be renamed and encryption settings can’t be changed later. The edit dialouge shows you what may be edited. + +edit + + +In this example, a new user has been added and the folder permissions are set to allow the new uers to view the Recipies folder. + + + From c869751cca9e8ae13c1635e9ca8c0cb9c0023ea9 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 13:12:27 +0100 Subject: [PATCH 06/14] Update create-a-new-folder.md added screenshot, corrected formatting --- docs/features/folders/create-a-new-folder.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/features/folders/create-a-new-folder.md b/docs/features/folders/create-a-new-folder.md index 80db6495..cf00c266 100644 --- a/docs/features/folders/create-a-new-folder.md +++ b/docs/features/folders/create-a-new-folder.md @@ -1,14 +1,14 @@ # How to Create a New Folder -To add a new folder, click *New Folder* +To add a new folder, click **New Folder** click-add-new-folder -You will then see the *Create Folder* dialogue +You will then see the **Create Folder** dialogue create-folder-1 -When creating a folder, first give it a name. You then have several other options that you may configure. You can skip this to use the default settings by clicking *Continue*. +When creating a folder, first give it a name. You then have several other options that you may configure. You can skip this to use the default settings by clicking **Continue**. ### Location This is which pool your folder will be on. If you have only one pool then this will be automatically selected. If you have multiple pools, perhaps with different performance characteristics or purposes, then select one here. @@ -16,7 +16,7 @@ This is which pool your folder will be on. If you have only one pool then this w location ### Access -On the menu select *Access*. Here you can choose who has access to this folder and what permissions they have. This is covered in more detail in the [Folder Permissions section](/folders/##folder-permissions). +On the menu select **Access**. Here you can choose who has access to this folder and what permissions they have. This is covered in more detail in the [Folder Permissions section](/folders/##folder-permissions). access @@ -41,15 +41,15 @@ You can optionally enable encryption on folders you create. [Read about encrypte encryption -**Important** Encryption can only be enabled during folder creation and cannot be disabled once the folder is created, nor can the passphrase be changed. +*Important* Encryption can only be enabled during folder creation and cannot be disabled once the folder is created, nor can the passphrase be changed. ### Finishing up creating a folder -Once you have checked your settings click *Continue* and check the details in the overview. +Once you have checked your settings click **Continue** and check the details in the overview. overview -If you wish to change anything, press the back button and edit the settings. When you are ready click *Create* and then the folder will be created. This may take a few moments. When the folder is created you will see it on the *Folders* screen. +If you wish to change anything, press the back button and edit the settings. When you are ready click **Create** and then the folder will be created. This may take a few moments. When the folder is created you will see it on the **Folders** screen. ## Editing folder settings @@ -57,7 +57,7 @@ To edit the settings for a folder go to Folders then click the folder you wish t click-folder -Then click *Edit* +Then click **Edit** Screenshot From 2025-10-03 14-13-34 @@ -65,9 +65,9 @@ Only some settings may be changed later. Folders cannot be renamed and encryptio edit +In this example, a new user has been added and the folder permissions are set to allow th66e new uers to view the Recipies folder. -In this example, a new user has been added and the folder permissions are set to allow the new uers to view the Recipies folder. - +save-edit From a72531960ee03300437c823ec95fcb671fe1afd2 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 13:15:32 +0100 Subject: [PATCH 07/14] Create how-to-access-folder-contents created doc on how to access the contents of the folder. added section for - windows - mac - chrome OS - linux todo: add contents and screenshots look at mobile --- .../folders/how-to-access-folder-contents | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/features/folders/how-to-access-folder-contents diff --git a/docs/features/folders/how-to-access-folder-contents b/docs/features/folders/how-to-access-folder-contents new file mode 100644 index 00000000..cd1c6031 --- /dev/null +++ b/docs/features/folders/how-to-access-folder-contents @@ -0,0 +1,20 @@ +# How to Access Files and Folders Over the Network + +Each folder has a **Browse** button that gives you the address you need to connect to it from your device. If you created a private folder you will need to connect to that folder using the associated Users credentials. + +## On Mac +Open Finder, click "Go" in the menu bar, select "Connect to Server". Paste the SMB link into the "Server Address" field and click "Connect". + +## On Windows +Open File Explorer, right-click on "This PC", then "Map network drive". Paste the SMB link into the "Folder" field and click "Finish" to connect. + +Screenshots + +## On ChromeOS + +Open the Files app, click the More menu (three-dots), click Services, then click SMB File Share. Then either select a suggested share or manually enter the URL using the format \\\\192.168.1.73\\Public. Fill out the fields and save. + +## On Linux + +This varies depending on your linux OS, however, the url required will probably be similar to the Mac one, with forward slashes smb://192.168.1.201/Folder (rather than windows and chrome with \\ back slashes) + From 5826ab9458a52e378543ed65988bd7f524cf2e28 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Tue, 7 Oct 2025 13:17:23 +0100 Subject: [PATCH 08/14] Rename how-to-access-folder-contents to how-to-access-folder-contents.md --- ...to-access-folder-contents => how-to-access-folder-contents.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/features/folders/{how-to-access-folder-contents => how-to-access-folder-contents.md} (100%) diff --git a/docs/features/folders/how-to-access-folder-contents b/docs/features/folders/how-to-access-folder-contents.md similarity index 100% rename from docs/features/folders/how-to-access-folder-contents rename to docs/features/folders/how-to-access-folder-contents.md From 32bc86419bd52ac8bbd23d3ddf988650dee68778 Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Thu, 9 Oct 2025 15:04:17 +0100 Subject: [PATCH 09/14] Update how-to-access-folder-contents.md - Full guides for Windows, ChomeOS and basic GUI for Linux. Todo - MacOS needs screenshots (I don't have access to a mac atm) - Screenshots could be better for Windows and Chrome, I will do new ones when I can (these are from a video from my brother) **Mobile** Need to do guides for android and iOS, I don't know enough about it atm. I can do a quick one with research, or you can if that's easier. I have left a "coming soon" at the bottom as I don't want it to seem like this isn't possible (I know it can be done) --- .../folders/how-to-access-folder-contents.md | 114 ++++++++++++++++-- 1 file changed, 105 insertions(+), 9 deletions(-) diff --git a/docs/features/folders/how-to-access-folder-contents.md b/docs/features/folders/how-to-access-folder-contents.md index cd1c6031..8cf99ba7 100644 --- a/docs/features/folders/how-to-access-folder-contents.md +++ b/docs/features/folders/how-to-access-folder-contents.md @@ -1,20 +1,116 @@ # How to Access Files and Folders Over the Network -Each folder has a **Browse** button that gives you the address you need to connect to it from your device. If you created a private folder you will need to connect to that folder using the associated Users credentials. +In HexOS, you [create folders](/folders/create-a-new-folder) through the deck - but you can’t add contents to the folders via the deck. + +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 wifi network. + +This guide will explain how to access a folder on your HexOS NAS from a variety of other devices. + +Note that this method is just for folders you have made, apps often have different methods of adding data. In Immich, for example, you upload photos via your browser. + +## Copying the Address of a Folder + +On the folders screen of your HexOS [deck](https://deck.hexos.com), click on the folder you want to access. Then click the **Browse** button. + +browse-button + +You will be given the folder “address”: this is what you need to connect to it from your device. You can tap the Copy button to copy the link and paste it following the instructions below. + +link-for-browse + +You can choose between Windows or Mac on the dropdown. + +choose-between-windows-or-mac + +Changing the Windows/Mac setting doesn't change the folder in any way, it just provides the link in a different format. In the address for accessing a folder over the network, some operating systems use forward slash \ and others use back slash /. + +## 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 -## On Mac Open Finder, click "Go" in the menu bar, select "Connect to Server". Paste the SMB link into the "Server Address" field and click "Connect". -## On Windows -Open File Explorer, right-click on "This PC", then "Map network drive". Paste the SMB link into the "Folder" field and click "Finish" to connect. +### On Windows +Open File Explorer. In the hand side there is a list of folders and drives: click on **This PC** + +this-pc + +Then right click for the menu and click **Add a network location** + +add-a-network-location + +Follow the wizard though by clicking **Next** + +next + +Press **Next** on the **Choose a custom network location** step + +choose-custom-next + +Paste the folder address in and click **Next** + +paste-in-address + +Choose a display name if you like. Press **Next** + +name-it + +Then click **Finish** + +finish + +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. + +password + +### On ChromeOS + +Open the My Files app + +my-files + +On the top right, click the more menu (three-dots). Click Services, then click SMB File Share + +services-smb-share + +Then either select a suggested share from the list or manually enter the URL using the format \\ipaddress\Folder-name. Fill out the password field if required. Click **Add** + +smb-share-login + +The file will now show in the left hand navigation on My Files + +shortcut-in-my-files + +### On Linux + +This varies depending on your linux OS. The url required will probably be similar to the Mac one, with forward slashes (rather than windows and chrome with \\ back slashes). The following example is from Fedora. + +Open your files app and click **Network** + +Paste in the folder address + +paste-in-address-1 + +Fill in the username and password if needed and click **Connect** + +enter-details + +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 + +files-shortcut -Screenshots +Sometimes the folder may show under **Other locations** -## On ChromeOS +other-locations -Open the Files app, click the More menu (three-dots), click Services, then click SMB File Share. Then either select a suggested share or manually enter the URL using the format \\\\192.168.1.73\\Public. Fill out the fields and save. +## Android -## On Linux +Guide coming soon -This varies depending on your linux OS, however, the url required will probably be similar to the Mac one, with forward slashes smb://192.168.1.201/Folder (rather than windows and chrome with \\ back slashes) +## iOS +Guide coming soon From e30835aee0df903cef10c93533d1f5477599c97a Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Fri, 10 Oct 2025 13:56:48 +0100 Subject: [PATCH 10/14] Create create-a-new-user.md basic create a user page with some screenshots edit info also --- docs/features/folders/create-a-new-user.md | 54 ++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/features/folders/create-a-new-user.md diff --git a/docs/features/folders/create-a-new-user.md b/docs/features/folders/create-a-new-user.md new file mode 100644 index 00000000..1891d7da --- /dev/null +++ b/docs/features/folders/create-a-new-user.md @@ -0,0 +1,54 @@ +# How to create a new user + +If you want to share selected folders or files with someone who has access to your wifi network, the best way to do this is by adding a new user in HexOS. + +You can control which folders the user can access, and what they can do with them - just view or also edit and delete folder contents. + +This user can’t access any other part of your server, for example they can’t access the HexOS dashboard or your Immich photos. This is just about folders on the network. + +You don’t *need* to add more users, it’s okay to keep using your admin username and password for everything. You could also create a user for yourself to use day to day, if you feel this would be more secure. + +## Adding a new user + +On your [deck](https://deck.hexos.com) go to the **Folders** screen. There click **Add new** under the **Users** section. (Your admin account dosen't show up in this list of users). + + +add-new-user + + +Fill out a **Username** and **Password** then click **Add account** + +set-username-and-password + +The user will then appear in the deck under the **Users** section of the **Folders** screen. This might take a few moments. + +user-is-there + + +## Changing the password of a user + +You can change the username or set a new password for an existing user. First go to the **Folders** screen on your [deck](https://deck.hexos.com) and then click on the user you wish to edit + +edit-user-1 + +Then click the **Edit** button + +edit-user-2 + + +You then see a dialogue where you can change the username and set a new password. Click **Update account** when you're done editing + +edit-user-password + +## How can a user access folders + +When you [create](/folders/create-a-new-folder) or [edit](/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](/folders/create-a-new-folder/#access) page here. + +The user will need to ser up 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 may 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. + + + From e9d86019d299fe2da84bd7ce5638312a5c61c91a Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Wed, 22 Oct 2025 12:53:14 +0100 Subject: [PATCH 11/14] Update index.md fixed dead link --- docs/features/folders/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/folders/index.md b/docs/features/folders/index.md index 846a3345..fa04b70c 100644 --- a/docs/features/folders/index.md +++ b/docs/features/folders/index.md @@ -12,7 +12,7 @@ In your [Deck](https://deck.hexos.com) click Folders on the sidebar menu. On thi folders-screen-hexos -You can’t go into the folders and browse the files from here: this screen only shows the folders and not the contents. [Read about how to access the folder contents here](/folders/how-to-access-files-and-folders-over-the-network) +You can’t go into the folders and browse the files from here: this screen only shows the folders and not the contents. [Read about how to access the folder contents here](/features/folders/how-to-access-folder-contents) ## Folder Permissions From db5e6c2f8326b12eb5dde209dd79b5374f5e5d7f Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Wed, 22 Oct 2025 12:55:21 +0100 Subject: [PATCH 12/14] Update how-to-access-folder-contents.md fixed broken link --- docs/features/folders/how-to-access-folder-contents.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/folders/how-to-access-folder-contents.md b/docs/features/folders/how-to-access-folder-contents.md index 8cf99ba7..ea63edae 100644 --- a/docs/features/folders/how-to-access-folder-contents.md +++ b/docs/features/folders/how-to-access-folder-contents.md @@ -1,6 +1,6 @@ # How to Access Files and Folders Over the Network -In HexOS, you [create folders](/folders/create-a-new-folder) through the deck - but you can’t add contents to the folders via the deck. +In HexOS, you [create folders](/features/folders/create-a-new-folder) through the deck - but you can’t add contents to the folders via the deck. 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 wifi network. @@ -33,7 +33,7 @@ Here are some examples of how to access the file from various devices. The speci Open Finder, click "Go" in the menu bar, select "Connect to Server". Paste the SMB link into the "Server Address" field and click "Connect". ### On Windows -Open File Explorer. In the hand side there is a list of folders and drives: click on **This PC** +Open File Explorer. In the hand side there is a list of and drives: click on **This PC** this-pc From 6a19a600a1a79723c1e7c0e8a57066174bb2787a Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Wed, 22 Oct 2025 12:57:16 +0100 Subject: [PATCH 13/14] Update create-a-new-user.md fixed 3 links --- docs/features/folders/create-a-new-user.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/folders/create-a-new-user.md b/docs/features/folders/create-a-new-user.md index 1891d7da..11301173 100644 --- a/docs/features/folders/create-a-new-user.md +++ b/docs/features/folders/create-a-new-user.md @@ -42,9 +42,9 @@ You then see a dialogue where you can change the username and set a new password ## How can a user access folders -When you [create](/folders/create-a-new-folder) or [edit](/folders/create-a-new-folder/#editing-folder-settings) a folder you can choose which users may access the contents and what permissions they have. +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](/folders/create-a-new-folder/#access) page here. +You can read about the **Access** settings on the [create a new folder](/features/folders/create-a-new-folder/#access) page here. The user will need to ser up access to the folders on their computer or phone as described in the [how to access folders guide](/folders/how-to-access-folder-contents). From 4e4116a84619dba8a9ab14c83c2ed2589af00f3d Mon Sep 17 00:00:00 2001 From: acknologia <64101826+acknologia@users.noreply.github.com> Date: Sun, 23 Nov 2025 03:01:25 -0500 Subject: [PATCH 14/14] revised all features/folders documentation revised create a new folder, create a new user, how to access folder contents, and features/folders --- docs/features/folders/create-a-new-folder.md | 57 ++++++++++------- docs/features/folders/create-a-new-user.md | 35 ++++++----- .../folders/how-to-access-folder-contents.md | 62 +++++++++++-------- docs/features/folders/index.md | 61 +++++++++--------- 4 files changed, 121 insertions(+), 94 deletions(-) diff --git a/docs/features/folders/create-a-new-folder.md b/docs/features/folders/create-a-new-folder.md index cf00c266..e114d90d 100644 --- a/docs/features/folders/create-a-new-folder.md +++ b/docs/features/folders/create-a-new-folder.md @@ -1,71 +1,80 @@ # How to Create a New Folder -To add a new folder, click **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 click-add-new-folder -You will then see the **Create Folder** dialogue +This will bring up the **Create Folder** dialogue create-folder-1 -When creating a folder, first give it a name. You then have several other options that you may configure. You can skip this to use the default settings by clicking **Continue**. +## General + +### Folder Name +- Select a folder name. +> **Note:** Folder name cannot be modified after folder creation. ### Location -This is which pool your folder will be on. If you have only one pool then this will be automatically selected. If you have multiple pools, perhaps with different performance characteristics or purposes, then select one here. +- 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. location -### Access -On the menu select **Access**. Here you can choose who has access to this folder and what permissions they have. This is covered in more detail in the [Folder Permissions section](/folders/##folder-permissions). +## Access (optional) +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). access -In essence, a private folder can only be accessed by the admin and users selected here. A public folder may be accessed by all users, and in theory anyone with your wifi password too. - In this example a user has been selected and given permission only to view the files. private-view-only -### Options +## Options -#### Quota -On the Options section you can set a maximum amount of disk space the folder may use up. This helps manage disk usage when multiple people or applications share your server. +### Folder storage limit (optional) +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. -#### Time Machine -On this same Options section you can Enable Time Machine. Enabling this feature sets up the folder with the proper configuration for Apple's backup system. +### Backup (optional) +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. options -### Encryption -You can optionally enable encryption on folders you create. [Read about encrypted folders](/features/folders/index.md#encrypted-folders) here. The password must be at least 8 characters long. Encryption is required for backing up a folder to another server. +## Encryption (optional) +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. +- Data from encrypted folders cannot be recovered if the passphrase is lost. encryption -*Important* Encryption can only be enabled during folder creation and cannot be disabled once the folder is created, nor can the passphrase be changed. +>**Important:** Encryption can only be enabled during folder creation and cannot be disabled once the folder is created, nor can the passphrase be changed. -### Finishing up creating a folder - -Once you have checked your settings click **Continue** and check the details in the overview. +## Finalizing New Folder Creation overview -If you wish to change anything, press the back button and edit the settings. When you are ready click **Create** and then the folder will be created. This may take a few moments. When the folder is created you will see it on the **Folders** screen. +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 for a folder go to Folders then click the folder you wish to edit. +To edit the settings of a folder go to the Folders screen and select the folder you wish to edit. click-folder -Then click **Edit** +Then select **Edit** Screenshot From 2025-10-03 14-13-34 -Only some settings may be changed later. Folders cannot be renamed and encryption settings can’t be changed later. The edit dialouge shows you what may be edited. +Folders cannot be renamed and encryption settings can’t be modified after folder creation.
The edit dialogue shows you what may be edited. edit -In this example, a new user has been added and the folder permissions are set to allow th66e new uers to view the Recipies folder. +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. save-edit diff --git a/docs/features/folders/create-a-new-user.md b/docs/features/folders/create-a-new-user.md index 11301173..f0700364 100644 --- a/docs/features/folders/create-a-new-user.md +++ b/docs/features/folders/create-a-new-user.md @@ -1,22 +1,25 @@ # How to create a new user -If you want to share selected folders or files with someone who has access to your wifi network, the best way to do this is by adding a new user in HexOS. +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 control which folders the user can access, and what they can do with them - just view or also edit and delete folder contents. - -This user can’t access any other part of your server, for example they can’t access the HexOS dashboard or your Immich photos. This is just about folders on the network. - -You don’t *need* to add more users, it’s okay to keep using your admin username and password for everything. You could also create a user for yourself to use day to day, if you feel this would be more secure. +- 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 -On your [deck](https://deck.hexos.com) go to the **Folders** screen. There click **Add new** under the **Users** section. (Your admin account dosen't show up in this list of users). +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 add-new-user -Fill out a **Username** and **Password** then click **Add account** +1. Select a **Username** and **Password** +2. Select **Add account** set-username-and-password @@ -27,16 +30,20 @@ The user will then appear in the deck under the **Users** section of the **Folde ## Changing the password of a user -You can change the username or set a new password for an existing user. First go to the **Folders** screen on your [deck](https://deck.hexos.com) and then click on the user you wish to edit +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 edit-user-1 -Then click the **Edit** button +Select the **Edit** button edit-user-2 -You then see a dialogue where you can change the username and set a new password. Click **Update account** when you're done editing +1. Change the username and set a new password if desired +2. Select **Update account** when you are finished. edit-user-password @@ -44,11 +51,11 @@ You then see a dialogue where you can change the username and set a new password 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](/features/folders/create-a-new-folder/#access) page here. +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 ser up access to the folders on their computer or phone as described in the [how to access folders guide](/folders/how-to-access-folder-contents). +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 may 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. +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. diff --git a/docs/features/folders/how-to-access-folder-contents.md b/docs/features/folders/how-to-access-folder-contents.md index ea63edae..2b56aa1c 100644 --- a/docs/features/folders/how-to-access-folder-contents.md +++ b/docs/features/folders/how-to-access-folder-contents.md @@ -1,28 +1,27 @@ # How to Access Files and Folders Over the Network -In HexOS, you [create folders](/features/folders/create-a-new-folder) through the deck - but you can’t add contents to the folders via the deck. +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.
+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. -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 wifi network. - -This guide will explain how to access a folder on your HexOS NAS from a variety of other devices. - -Note that this method is just for folders you have made, apps often have different methods of adding data. In Immich, for example, you upload photos via your browser. +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 -On the folders screen of your HexOS [deck](https://deck.hexos.com), click on the folder you want to access. Then click the **Browse** button. +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 browse-button -You will be given the folder “address”: this is what you need to connect to it from your device. You can tap the Copy button to copy the link and paste it following the instructions below. +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. link-for-browse -You can choose between Windows or Mac on the dropdown. +You can select Windows or Mac using the dropdown. choose-between-windows-or-mac -Changing the Windows/Mac setting doesn't change the folder in any way, it just provides the link in a different format. In the address for accessing a folder over the network, some operating systems use forward slash \ and others use back slash /. +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 @@ -30,34 +29,40 @@ Here are some examples of how to access the file from various devices. The speci ### On Mac -Open Finder, click "Go" in the menu bar, select "Connect to Server". Paste the SMB link into the "Server Address" field and click "Connect". +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 -Open File Explorer. In the hand side there is a list of and drives: click on **This PC** +1. Open File Explorer +2. On the left side there is a list of folders and locations, select **This PC** this-pc -Then right click for the menu and click **Add a network location** +1. Right click for the menu +2. Select **Add a network location** add-a-network-location -Follow the wizard though by clicking **Next** +Follow the wizard though by selecting the **Next** button. next -Press **Next** on the **Choose a custom network location** step +Select the **Next** button on the **Choose a custom network location** step. choose-custom-next -Paste the folder address in and click **Next** +Paste the folder address in and select the **Next** button. paste-in-address -Choose a display name if you like. Press **Next** +You can optionally choose a display name. Select the **Next** button. name-it -Then click **Finish** +Then select the **Finish** button. finish @@ -69,15 +74,19 @@ If the folder is private you will be asked for a username and password before it ### On ChromeOS -Open the My Files app +Open the My Files app. my-files -On the top right, click the more menu (three-dots). Click Services, then click SMB File Share +1. On the top right, select the menu button (three vertical dots) +2. Select Services +3. Select SMB File Share services-smb-share -Then either select a suggested share from the list or manually enter the URL using the format \\ipaddress\Folder-name. Fill out the password field if required. Click **Add** +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** smb-share-login @@ -87,15 +96,16 @@ The file will now show in the left hand navigation on My Files ### On Linux -This varies depending on your linux OS. The url required will probably be similar to the Mac one, with forward slashes (rather than windows and chrome with \\ back slashes). The following example is from Fedora. - -Open your files app and click **Network** +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. -Paste in the folder address +1. Open your files app +2. Select **Network** +3. Paste in the folder address paste-in-address-1 -Fill in the username and password if needed and click **Connect** +1. Fill in the username and password if needed +2. Select **Connect** enter-details diff --git a/docs/features/folders/index.md b/docs/features/folders/index.md index fa04b70c..ea37da3e 100644 --- a/docs/features/folders/index.md +++ b/docs/features/folders/index.md @@ -1,52 +1,55 @@ # Folders -In HexOS, folders are used to organise your data. Some folders are automatically created when applications are installed, and you can create your own folders too. +Folders can be used to organize data, share files over the network and for back up with tools like Apple time machine. You are able to create folders and they can be automatically created when applications are installed. -You might want to make folders for organizing data, sharing files over the network and for backing up other devices with tools like Apple Time Machine and Windows Backup. - -Folders can be password protected or not, and they can be encrypted. You can also create users and decide what they can view and edit. +Folders can optionally be password protected and encrypted. You can also create users and decide what they can view and edit. ## The Folders Screen -In your [Deck](https://deck.hexos.com) click Folders on the sidebar menu. On this screen you can see your folders, see system folders, add new folders and add new users too. +You can access the Folders screen in the [Deck](https://deck.hexos.com) through the sidebar menu. On this screen you can view existing folders, create new folders and network credentials for accessing folders. folders-screen-hexos -You can’t go into the folders and browse the files from here: this screen only shows the folders and not the contents. [Read about how to access the folder contents here](/features/folders/how-to-access-folder-contents) +You can’t browse the files from here. The Folders screen only shows the folders and not their contents.
[Read about how to access the folder contents here](/features/folders/how-to-access-folder-contents) ## Folder Permissions -It’s a good idea to understand how the privacy and security of your folders is managed. You will be able to choose from the options below when creating a folder. +### Permission Types -### Folder Types +You can give users specific types of access to folders: -#### Public folders +#### Read access -Anyone can access these folders. This will include all users you have created. This also means that, at least in theory, anyone who has your wifi password can view, edit and delete the contents of the folder. +Users with read access can view or download folder contents but can't edit or delete the contents. -#### Private folders +#### Write access -Only people with a username and password can access these folders. This means by default only the administrator has access. Then, any users that the administrator has created can also be granted access to the private folder. Finally, whether the user may only view or also edit/delete the contents of the folder is defined in the folder settings. +Users with write access can add, modify or delete the contents of the folder. -In theory anyone with your wifi password may be able to see the folder name. Also anyone with access to the hard drives in your system may be able to read the data. +## Folder Types -#### Encrypted folders +### Public folders -These folders may be public or private as above. However, when they are set to “locked” by the admin the contents will not be accessible to anyone while the folder remains locked. This means users cannot see the contents of the folder, including the admin, nor can people with the wifi password or with physical access to the hard drives. +Anyone can access these folders. This will include all users you have created. This means that anyone with access to your network can view, edit or delete the contents of these folders. -When the folder is “unlocked” again the contents will then be accessible as specified by the other settings and permissions. Encryption is required for backing up a folder to another server. +### Private folders -### Permission Types +Only those with network credentials created in HexOS can access these folders.
This means by default only the administrator has access. The administrator grant access to anyone given network credentials. Folder permissions for this type of folder can be modified. -You can give users specific types of access to folders: +- Anyone with access to your network are able to see private folder names. +- Anyone with access to the hard drives in your server may be able to read the data. -#### Read access - -Users can view and download files but can't edit or delete anything. - -#### Write access +### Encrypted folders -Users can add, modify, and delete files in the folder. Edits and deletes are permanent. +File encryption is when a file's data is scrambled in a way it can only be recovered with a specific encryption key or passphrase.
When we create an encrypted folder, all of the contents placed i that folder will also be encrypted. The server administer can lock (encrypt) or unlock (decrypt) folders from the folder section of HexOS deck.
When a folder is locked, the folder and its contents are not visible nor accessible to anyone on the network. When a folder is unlocked it will work the same as a regular folder.
+- Encrypted folders can be selected to be public or private +- Encryption is required for backing up a folder to another server. +- The data on your server’s storage drives cannot be read even if someone gains physical access to them. +- Selected passphrase must be a minimum of 8 characters long. +- The selected passphrase is needed to unlock encrypted folder every time. +- Passphrase cannot be changed after folder creation. +- If the passphrase is lost, data cannot be recovered by HexOS. +> **Note:** Encryption can only be enabled during folder creation and cannot be disabled once the folder is created. ## Users @@ -54,15 +57,14 @@ Creating additional users is optional. Your user account is automatically an administrator: this means you always have full access to all your folders. -You might wish to create more users if you want other people to access some folders, but you don’t want to share your admin credentials. For example, you want to enable family members to back up their devices without risking them accidentally deleting other items. - -You can select which users have access to folders during creation of folders. This can also be edited later for any folder. +You can to create more users in order to grant others access to private folders. +You can grant access to selected users during folder creation. Access to folders can be modified at in the folder screen. -User accounts you create here are just for folder access through network file browsers like Finder or Windows Explorer. They don't give people any control over your server or applications - only the admin account has this access. +User accounts created here only grant folder access through network file browsers like MacOS Finder or Windows Explorer. These accounts don't allow any control over your server or applications. ## System Folders -When you install apps they automatically create "System Folders" for their data. These appear separately from your personal folders and are managed by the apps themselves. +When apps are installed, they automatically create "System Folders" for their data. These appear separately from your personal folders and are managed by the apps themselves. ### Reserved names @@ -72,4 +74,3 @@ Certain folder names like "Downloads" are reserved for system use. If you create These folders have default locations, but you can change where they're created in [locations](/features/settings/#locations). -