Advanced Usage


Advanced client (ported from our Connector device) turns any single-board computer (SBC) or a Linux box into a NAS connected to your On My Disk account. Besides, it allows you to host Jekyll (static websites generator) and PeARS (People’s Search Engine) locally on your device. The package is available for armhf and amd64 Linux platforms:

  • Armbian, Raspbian ARM SBC-s like Raspbery Pi:
    wget https://forge.bineon.team/repo/Ubuntu/focal/onmydisk-connector-armhf.deb
    sudo apt install ./onmydisk-connector-armhf.deb
    
  • Intel-based boards and Ubuntu/Debian workstations:
    wget https://forge.bineon.team/repo/Ubuntu/focal/onmydisk-connector-amd64.deb
    sudo apt install ./onmydisk-connector-amd64.deb
    

    Run On My Disk service:

    sudo systemctl start onmydisk
    sudo systemctl enable onmydisk
    

    Next, open your browser and go to http://your_device_name.local/ or http://localhost/. Log in using your On My Disk account credentials to access the familiar On My Disk web interface. Navigate to Settings -> Device to configure your device.

PeARS Integration

  • First, install and run PeARS according to user manual: https://github.com/PeARSearch/PeARS-OMD
  • Enter your PeARS token in Search engine token field. Make sure you have defined this token in pears.ini
  • Restart On My Disk by running
    sudo systemctl restart onmydisk
    

    Reindexing should start when new storage devices are detected.

Jekyll Integration

Jekyll engine should be installed automatically with the advanced client. Make sure it is present on the system by checking Jekyll location:

sudo which jekyll
/usr/local/bin/jekyll 

If system-wide Jekyll could not be installed (on some older OS-es), please refer to Jekyll documentation (https://jekyllrb.com/) to setup it locally for you user account. After that, modify Sites service (/etc/systemd/system/sites.service) to run under your user account:

[Unit]
Description=On My Disk Sites Service
After=network.target

[Service]
Type=simple
User=your_user
WorkingDirectory=/usr/lib/onmydisk/sites
# Set environment variables
Environment="PATH=/home/your_user/.rbenv/shims:/home/your_user/.rbenv/bin:/home/your_user/gems/bin:/usr/local/bin:/usr/bin:/bin"
Environment="GEM_HOME=/home/your_user/gems"
Environment="GEM_PATH=/home/your_user/gems:/usr/lib/ruby/gems/3.0.0"

ExecStart=/bin/bash /usr/lib/onmydisk/sites/serve-all.sh
Restart=on-failure

[Install]
WantedBy=multi-user.target

After that, reload services configuration and restart On My Disk:

sudo systemctl daemon-reload
sudo systemctl restart onmydisk

Now navigate to Sites folder on your device and launch New website wizard:

  • You can choose one of the supported themes tailored to your needs, such as a personal blog, a product or company landing page, or a documentation site.
  • Note: Please avoid spaces and special characters in the site name.
  • Although hosted locally, your site will be accessible online at https://onmydisk.net/sites/your_site_name/

NAS Features

Unlock powerful network storage capabilities with these features:
🎛️ Plug and Play: check Automatically mount external drives to make connected USB drives automatically appear as storage devices in your On My Disk account.
📂 Automatic Indexing: All files on the mounted drive are indexed instantly, making them searchable and accessible via the web app.
🌐 Seamless assess: check Publish as network drives to make you external drives available as network drives in your local network.
📺 Stream with ease: check Add to media library to make your files accessible on your smart TV or other DLNA-compatible devices.

This should be perfect for headless devices like Raspberry Pi or similar setups.

Other Apps

➡️ Enable applications you need in your account under Profile->Applications.

Known Limitations

  • Currently, our search engine supports four languages: English, French, Russian and Slovenian. If you have documents in a particular language, you can restrict the search by adding the correct language code to your query. For instance, you can add -fr at the end your query to search in French exclusively.
  • The following text file formats are scanned for contextual search: txt, markdown, html, pdf, odt, docx, pptx, latex, epub, fb2, csv. We are actively expanding this list.
  • Search support for non-textual files is restricted to those with extractable metadata, such as photos with exif headers and music files with embedded tags.

Recommendations

  • Enhance search relevance by assigning meaningful names to files and folders, organizing them in logical structures. Additionally, provide file descriptions (in file’s properties dialog) to enhance searchability for important files.
  • Refrain from removing metadata from files to enhance searchability.
  • Indexing speed: Depending on the size and complexity of your storage, indexing may take some time. We recommend being patient during this process.
  • Security: Ensure that your account credentials are kept secure and avoid sharing them with unauthorized individuals. Additionally, follow best practices for securing your devices and network to prevent unauthorized access to your files.