LochNAS Setup

Table of Contents

Requirements>

Requirements #

Ubuntu 20 server or greater is the preffered setup used for this system.
root user access
Port forwarding 80 + 443
Static IP on Server, alternative is DHCP reservation on router.
Windows Guide - Untested
OSX Guide - Untested

Install>

Install #

Run the following command below

sudo curl -fsSL https://raw.githubusercontent.com/SiloCityLabs/lochnas/v3/install.sh -o install.sh && sudo sh install.sh

Edit your config.yml then restart service lochnas restart. If you are running your setup on a residential isp we recommend following our ddns guide.

Updates>

Updates #

LochNAS uses git to update. You can configure your update schedule via the config.yml file.

Commands>

Commands #

    server.bin -daemon
        start - Start in background
        stop - Stop background
        restart - restart in background
        install - Install as service
        uninstall - Uninstall service
    server.bin -ddns
        ip - Grab current wanip from router
        refresh - update ddns if ip changed
        force - Force update ddns ip
    server.bin -domain
        renew - Renew all domains
        add - Renew all domains, expects domain as argument
        delete - Renew all domains
    server.bin -apps
        update - Update
    server.bin -server
        notify - Send test notifications
    server.bin -config /path/to/alt/config

Create users and groups (optional)>

Create users and groups (optional) #

This portion is handled by the containers but in some instances file permissions may have changed. We will be using the www-data user to share permissions between services. You can make seperate users and groups if you would like to but I found that this is the easiest way to manage access accross the board.

You can give your user access to any files of www-data with this command.

usermod -aG www-data yourusername

If you need to access the local folder mounted in the compose file at /lochnas/home from nextcloud local storage plugin, you can run the following set of commands on a folder to grant permission:

chown -R www-data:www-data /lochnas/home
chmod -R 770 /lochnas/home

Apps>

Apps #

Each app has its own .env to enable in /lochnas/docker-templates/{appname}/.env. See app docs for more information to get started. We recommend activating nginx first.

Hint, to see dot files in a folder you need to use ls -a command.