Onion Drive User Manual
1. Introduction
Welcome to Onion Drive! This guide will help you understand and make the best use of all the features offered by our secure platform for managing your files. Onion Drive is designed to give you control and privacy over your data.
2. Dashboard Overview
Once logged in, you will be directed to the main Dashboard. Here you can manage all your files and account settings.
The top part of the page (Header) contains:
- The Onion Drive logo and name.
- User information:
- Storage Quota: Shows the storage space used versus the total available (e.g., "Storage: 0.05 GB / 5 GB").
- Logout Link: To securely log out of your account (e.g., "Logout (username)").
2.2 Path Navigation (Breadcrumbs)
Below the header, you will find the path navigation bar (commonly called "breadcrumbs"). This shows your current location within the folder structure and allows you to quickly return to parent folders.
- Click on Home to return to the main folder (Root).
- Click on a folder name in the path to navigate directly to that folder.
- The name of the current folder is displayed in bold.
2.3 Search Bar
You can search for files and folders within the current location using the search bar.
- Enter the name (or part of the name) of the item you are looking for in the Search in current folder by name... field.
- Press the Search button or Enter to start the search.
- To clear the search results and return to the normal folder view, click on Clear Search (visible only when a search is active).
2.4 Quick Actions
The "Quick Actions" sidebar (especially visible on larger screens, or as the first block on smaller screens) allows you to quickly access main functionalities:
- Create new folders.
- Upload files.
- Change your password.
- Manage Two-Factor Authentication (2FA).
- Manage your PGP public key.
Details on each of these actions are provided in the following sections.
2.5 File and Folder List
The main area of the dashboard displays the list of files and folders present in the current location. For each item, you will see:
- An icon (📁 for folders, 📄 for files).
- The item name.
- For files, the size (in KB or MB) and sometimes the MIME type.
- The upload date (for files) or creation date (for folders).
- A series of available actions for that item.
If a folder is empty or a search yields no results, you will see an appropriate message.
3. Account Management
3.1 Logout
To securely log out of your account, click on the Logout (username) link in the header at the top right.
3.2 Storage Quota Check
In the header, you can always see the status of your storage space (e.g., Storage: X GB / Y GB).
3.3 Change Password
In the "Quick Actions" section:
- Find the Change Password section.
- Enter your current password in the Current Password field.
- Enter your new password (minimum 8 characters) in the New Password field.
- Confirm the new password in the Confirm New Password field.
- Click the Change Password button. You will receive a confirmation or error message.
3.4 Two-Factor Authentication (2FA)
Increase your account security by enabling 2FA. You can find this in the "Quick Actions" section.
Enabling 2FA:
- If 2FA is disabled, click on Enable 2FA.
- A "Step 1: Scan QR Code" section will appear. Use your authenticator app (e.g., Google Authenticator, Authy) to scan the displayed QR code.
- Alternatively, you can manually enter the textual Secret Key into your app.
- In the "Step 2: Verify Code" section, enter the 6-8 digit code generated by your authenticator app into the Enter code from authenticator app field.
- Click on Verify & Enable 2FA.
- If the code is correct, 2FA will be enabled. Recovery Codes will be displayed. **Save these codes in a safe place!** They are the only way to access your account if you lose your authenticator device. Each code can only be used once.
- Click on I have saved these codes to close the recovery codes display.
Disabling 2FA:
- If 2FA is enabled, you will see a confirmation message.
- Click the Disable 2FA button.
- Confirm your intention when prompted.
Recovery Codes Information:
If 2FA is active, you can click on View Recovery Codes Info to be reminded that if you lose them, you must disable and then re-enable 2FA to generate a new set.
3.5 PGP Public Key Management
You can add a PGP public key to your profile for future encryption features. This feature is optional and located in the "Quick Actions" section.
Adding/Updating PGP Key:
- Find the PGP Public Key Management section.
- Paste your complete PGP public key (including `-----BEGIN PGP PUBLIC KEY BLOCK-----` and `-----END PGP PUBLIC KEY BLOCK-----`) into the provided text area.
- Click on Save / Update PGP Key.
Removing PGP Key:
- If a PGP key is already set, a Remove PGP Key button will appear. Click it and confirm to remove the key.
- Alternatively, you can clear the content of the key text area and click Save / Update PGP Key to remove it.
4. File and Folder Operations
4.1 Create New Folders
From the "Quick Actions" section:
- Enter the desired name for the new folder in the field under Create New Folder.
- Click the Create Folder button.
- The new folder will appear in the file list of the current location.
4.2 Upload Files
From the "Quick Actions" section, in the Upload File area:
- **Drag & Drop:** Drag one or more files from your computer directly onto the dashed area Drag and drop one or more files here....
- **Manual Selection:** Click the Choose files from disk button to open your system's file dialog and select files.
- Once files are selected (by either method), the feedback below the drop area will show the chosen files.
- Click the Upload Selected File(s) button to start the upload.
Note: There are limits on the maximum size of uploaded files, defined by the server.
4.3 Navigate Folders
- In the file list, click on a folder name (accompanied by the 📁 icon) to open it and view its contents.
- Use the Path Navigation (Breadcrumbs) at the top of the file list to return to previous folders or to Home.
4.4 View Files
For supported files, you can view them directly in the browser without downloading:
- Images: Click the View action. The image will open in a modal viewer with controls to rotate, zoom, and reset the view. You can also pan a zoomed image.
- Videos: Click the Play action. The video will open in a modal player with playback controls.
- Text Files: Click the Edit action (see next section).
Modals can be closed by clicking the 'X', pressing the `ESC` key, or clicking on the dark background.
4.5 Edit Text Files
For text files (e.g., `.txt`, `.md`, `.json`, `.xml`):
- Click the Edit action next to the file.
- A modal text editor will open with the file's content.
- Make the necessary changes.
- Click Save Changes to save, or Cancel to close without saving.
4.6 Rename Files and Folders
- Find the file or folder you wish to rename in the list.
- Click the Rename action.
- A dialog box will appear asking for the new name. Enter it and confirm.
4.7 Delete Files and Folders
- Find the file or folder to delete.
- Click the Delete action (usually red or with a trash icon).
- A confirmation prompt will appear. Read it carefully:
- Deleting a file is generally irreversible.
- Deleting a folder will delete **ALL** files and subfolders within it, and this action is irreversible.
- Confirm to proceed with the deletion.
4.8 Download Files
For each file in the list, you can click the Download action to save it to your computer.
4.9 Move Files and Folders
You can move files and folders to other folders using drag & drop:
- **Drag the Item:** Click and hold on a file or folder you wish to move.
- **Drop on Destination:**
- Drag the item over another folder in the file list. The destination folder will highlight. Release to move the item into it.
- Drag the item over a folder name in the Path Navigation (Breadcrumbs). The folder link will highlight. Release to move the item into that folder.
Notes: You cannot move a folder into itself or one of its subfolders. You cannot move an item into a folder if an item with the same name already exists at that destination.
(A modal "Move" option might also be available in the future, allowing destination selection from a folder tree.)
5. Advanced Features
5.1 Share Files
You can create shareable links for your files:
- Find the file you want to share and click the Share button.
- A "Share File" modal window will open.
- **Existing Shares:** If there are already active share links for that file, they will be listed here. You can see the link, type, expiration date (if applicable), and remove existing links by clicking Remove.
- **Create New Share Link:**
- Select the Share Type:
- Permanent: The link does not expire (unless manually removed).
- Password Protected: You must set a password (minimum 6 characters) to access the file.
- Time-Limited: Specify a duration in hours for which the link will be valid (default 24 hours).
- If you chose "Password Protected," enter a password.
- If you chose "Time-Limited," enter the duration.
- Click Create Link.
- The newly created link will appear below. You can copy it by clicking Copy.
- Click Close to close the modal window.
5.2 Encrypt Files with PGP
If you have added a PGP public key to your profile (see section 3.5), you can encrypt your files directly on the platform:
- Ensure you have a valid PGP public key in your profile.
- Find the file you wish to encrypt. The file must not already be PGP encrypted.
- Click the Encrypt (PGP) button (usually an informational color, e.g., blue).
- A confirmation prompt will appear. Read it carefully: **this action will replace the original file with its encrypted version and cannot be undone through the user interface.**
- Confirm to proceed. The file will be encrypted with your PGP public key.
- Once encrypted, the original file is removed and replaced by its encrypted version. A PGP Encrypted indicator may appear next to the file.
Note: To decrypt a PGP encrypted file, you will need to download it and use your corresponding private PGP key with appropriate PGP software on your computer.
6. Understanding the Interface
The Onion Drive dashboard is designed to be intuitive. The main sections are:
- **Header:** Quick access to username, quota, and logout.
- **Path Navigation (Breadcrumbs):** Helps you understand your location and navigate easily.
- **Quick Actions:** Contains common commands for managing folders, files, and account settings.
- **File/Folder List:** The central area where you interact with your data.
- **Modals:** Dialog windows that appear for specific actions like viewing images/videos, editing text, sharing files, or moving items.
Button and label names may vary slightly if you have set a different language for your browser/service.
At the bottom of the page, the footer contains copyright information and useful links, such as contact details and the service manifesto.