Home NAS deploment

Before All...

1. What is a home NAS?

A typical home NAS is used for storing and sharing photos and files. As an extension to traditional NAS, the server config followed by this article would include more applications like offline downloader, media server, and printer server...

2. Hardware requirement:

Any kind of popular architecture (x86, amd64, arm64) CPU, with high-speed network (ethernet, WIFI) and disk (USB3.*, SATA, NVME) interface. I'm not going to stop you from using an Android phone with a type-C to 4*USB (with PD backwards charging) as your cherished server.

Because technically I used such a server for more than 6 months, a Raspberry Pi 4. I had developed a habit to reboot it regularly every 2 days and bear the risk of losing all data.

So, be kind to yourself at this stage. Power and noise worth be considered as part of the budget, and also extension capability.

This is my current hardware, just for reference:

cpu:
                      Intel(R) Celeron(R) N5105 @ 2.00GHz, 2800 MHz
graphics card:
                      Intel JasperLake [UHD Graphics]
disk:
  /dev/nvme0n1         KIOXIA NVMe SSD  # root disk
  /dev/sda             TOSHIBA MG08ADA8 # data disk
memory:
                      Memory Size: 15 GB

Choice of Operating System

Linux

Not a nerd? Go for Synology NAS

About File System

I'm currently using Btrfs, which is a native Linux file system that has lots of modern features attracts me:

1. CoW (copy on write): File won't be overwritten partially and then broken after a sudden power outage
2. Compression: save your disk and money
3. Subvolume and snapshot: save your data from accident such as you deleted your system (you won't, right?)

How to install Linux

I believe there are thousands of tutorials for beginners.

Join the Arch "cult"

I don't trust any binary distro, I want to compile everything, where should I start?

I just want a normal and stable one

Docker Network:

networks:
  redisnet:                         # cache for Nextcloud
  NPM:                              # all apps should be under this subnet
    driver: bridge
    ipam:
      config:
        - subnet: 10.5.0.0/16
  qb-ipv6:                          # for IPv6 download
    enable_ipv6: true
    driver: bridge
    ipam:
      driver: default
      config:
        - subnet: 2001:3200:3200::/64
          gateway: 2001:3200:3200::1

Frpc

frp:
  restart: always                           # auto start after a reboot
  image: snowdreamtech/frpc:0.51.0
  container_name: frpc
  network_mode: "host"                      # use the host network
  volumes:
  # mount the config file dir into docker container (read only)
    - /all-docker-data/frp:/etc/frp:ro

Nginx Proxy manager

NPM:
  image: jc21/nginx-proxy-manager:latest
  container_name: nginx-proxy-manager
  restart: unless-stopped
  networks:
    NPM:
      ipv4_address: 10.5.0.3                        # address frpc should point to
  ports:
#      - "0.0.0.0:81:81"                            # Admin WebUI, disable after setup
    - "[::]:81:80"                                  # For IPv6 access (The default is block byb 3BB -_-)
    - "[::]:444:443"
  volumes:
    - /.../NPM/data:/data                           # WebUI data
    - /.../NPM/letsencrypt:/etc/letsencrypt         # https certificates

Offical website

After you login to the WebUI, setup a proxy like this:

HTTPS:

Nextcloud

Nextcloud: It is a suite of client-server software for creating and using file hosting services.

db:                                         # database
    image: mariadb:10.6
    restart: always
    command: --transaction-isolation=READ-COMMITTED --log-bin=binlog --binlog-format=ROW
    volumes:
      - /.../nextcloud/db:/var/lib/mysql
    environment:
      - MYSQL_ROOT_PASSWORD=CHANGEME
      - MYSQL_PASSWORD=CHANGEME
      - MYSQL_DATABASE=nextcloud
      - MYSQL_USER=nextcloud

  redis:
    image: redis:alpine
    restart: always
    networks:
      - redisnet
    expose:
      - 6379

  nextcloud:
    image: nextcloud
    restart: always
    depends_on:
      - db
      - redis
    links:
      - db
    volumes:
      - /.../nextcloud/html:/var/www/html             # all your files
    environment:
      - REDIS_HOST=redis
      - MYSQL_PASSWORD=CHANGEME             # same password as in db
      - MYSQL_DATABASE=nextcloud
      - MYSQL_USER=nextcloud
      - MYSQL_HOST=db
      - PHP_MEMORY_LIMIT=1024M
      - PHP_UPLOAD_LIMIT=1024M
    networks:
      redisnet:
      default:
      NPM:
        ipv4_address: 10.5.0.5

Offical examples

Nextcloud requires some small tuning, check out the auto health-check in setting (click your account icon), and edit /.../nextcloud/html/config/config.php according to the document.

If Nextcloud is behind NPM, you need to add its address to trusted_domains and trusted_proxies, for me:

'trusted_domains' =>
array (
  0 => 'cloud.bajzc.com',
  1 => '10.5.0.5',
  2 => '10.5.0.3',
  3 => 'cloud6.bajzc.com',
),
'trusted_proxies' =>
array (
  0 => '10.5.0.0/16',
),

As NPM is using HTTP to communicate with Nextcloud:

'overwriteprotocol' => 'https',
'overwritecondaddr' => '^10\\.5\\.0\\.3$',   // NPM address here
'forwarded-for-headers' =>
array (
  0 => 'X-Forwarded-For',
  1 => 'HTTP_X_FORWARDED_FOR',
),

Docker Compose

All the config scripts I shared are part of the final docker-compose.yml file.

Install docker and docker-compose, edit your docker-compose.yml and run docker compose up -d under the same folder to start all the applications.