USAGE.md

How to Use Veracrypt GUI on Unraid

This guide will walk you through setting up and using the Veracrypt GUI Docker container on your Unraid server.

📖 Table of Contents

• Initial Setup
• Accessing the GUI
• Creating and Mounting Volumes
• SMB Share Configuration
• Troubleshooting

Initial Setup

[Screenshots will be added here showing the steps]

1. After installing the template, navigate to your Docker settings
2. Locate and click on the Veracrypt container
3. Configure the following paths:
   • /mnt/user/appdata/veracrypt-gui for configuration
   • /mnt/user/containers for container storage
   • /mnt/disks for mounted volumes

Accessing the GUI

1. Once the container is running, access the web interface at:

   http://[YOUR-UNRAID-IP]:5800
   

2. You should see the Veracrypt GUI interface in your browser

Creating and Mounting Volumes

1. Using the GUI interface:
   • Create new volume or select existing one
   • Choose mount location
   • Enter credentials
2. Mounted volumes will be available in the /mnt/disks directory

SMB Share Configuration

To share your Veracrypt volumes over the network, add the following configuration to your Unraid SMB settings:

[veracrypt1]
      path = /mnt/disks/veracrypt1
      comment = 
      browseable = yes
      writeable = no
      read list = 
      write list = %%username%%
      valid users = %%username%%
      case sensitive = auto
      preserve case = yes
      short preserve case = yes

Configuration Breakdown:

• path: Points to your mounted Veracrypt volume
• browseable: Makes the share visible in network browsing
• writeable: Set to 'no' by default for security
• write list: Allows specified users to write to the share
• valid users: Controls who can access the share
• case sensitive: Handles file name case sensitivity

Setting Up the Share:

1. Navigate to Unraid's SMB settings
2. Add the above configuration
3. Replace %%username%% with your actual username
4. Save and restart the SMB service
5. Now you should see your share on your server

Security Considerations

1. Access Control:

   • Use strong passwords for Veracrypt volumes
   • Limit network share access to specific users
   • Consider using read-only shares when possible

2. Network Security:

   • Use encrypted connections when possible
   • Limit access to trusted network segments
   • Regularly review access logs

Troubleshooting

Common Issues and Solutions:

1. Mount Problems:

   • Verify container permissions
   • Check path configurations
   • Ensure correct credentials
   • Make sure image is mount in Veracrypt

2. SMB Access Issues:

   • Confirm user permissions
   • Verify network connectivity
   • Check Unraid's SMB logs

3. GUI Access Problems:

   • Verify container is running
   • Check port configuration
   • Review container logs

---

For more detailed information, visit the main README.