English | Traditional Chinese 繁體中文 | Simplified Chinese 简体中文

(The translated README pages are not updated at this time)

NextcloudPi

This is the build code for the NextcloudPi open-source community project.

NextcloudPi is a ready to use image for Virtual Machines, Raspberry Pi, Odroid HC1, Rock64 and other boards. (⇒ Downloads)

This code also generates the NextcloudPi LXD and LXC containers and there is an install script for the latest supported Debian based system as well.

Find the documentation at docs.nextcloudpi.com, the documentation is all written by volunteers.

Please reach out in the Matrix or Telegram Wiki group chats if you want to help out to keep them up-to-date and we'll add you to the Wiki Group on the forum.

---

Test Status

master

devel

---

Features

• Raspberry Pi OS/Debian 12 (Bookworm)
• Nextcloud
• Apache, with HTTP2 enabled
• PHP 8.1
• MariaDB
• Redis memory cache
• ncp-config TUI for easy setup ( RAM logs, USB drive and more )
• Automatic redirection to HTTPS
• APCu PHP cache
• PHP Zend OPcache enabled with file cache
• HSTS
• Cron jobs for Nextcloud
• Sane configuration defaults
• Full emoji support
• Postfix email
• Secure

Extras

• Setup wizard
• NextcloudPi Web Panel
• Wi-Fi ready
• Ram logs
• Automatic security updates, activated by default.
• Let’s Encrypt for trusted HTTPS certificates.
• Fail2Ban protection against brute force attacks.
• UFW firewall
• Dynamic DNS support for no-ip.org
• Dynamic DNS support for freeDNS
• Dynamic DNS support for duckDNS
• Dynamic DNS support for spDYN
• Dynamic DNS support for Namecheap
• dnsmasq DNS server with DNS cache
• ModSecurity Web Application Firewall
• NFS ready to mount your files over LAN
• SAMBA ready to share your files with Windows/Mac/Linux
• USB automount
• Remote updates
• Automatic NCP updates
• Automatic Nextcloud updates
• Update notifications
• Nextcloud backup and restore
• Nextcloud online installation
• Format USB drive to BTRFS
• BTRFS snapshots
• Automatic BTRFS snapshots
• BTRFS snapshot auto sync
• scheduled rsync
• UPnP automatic port forwarding
• Security audits with Lynis and Debsecan
• ZRAM
• SMART hard drive health monitoring

Extras can be activated and configured using the web interface at HTTPS port 4443

Or from the command line using

sudo ncp-config

Docker has been discontinued

Docker has been discontinued for the time being, please read the announcement here: https://help.nextcloud.com/t/nextcloudpi-planning-to-discontinue-its-docker-version-with-nc-25/158895

Run in LXD

# Imports the LXC image, replace the X's with version number
lxc image import "NextcloudPi_LXD_vX.XX.X.tar.gz" --alias "nextcloudpi"

# Launches a container from the image
lxc launch "nextcloudpi" ncp

# Starts the container you've launched from the imported image
lxc start ncp

Run in Proxmox

There are two ways to run NCP on Proxmox:

1. Using the official release image

In your Proxmox web interface, head to any storage pool that has CT Templates enabled, go to CT Templates, click "Download from URL" and enter the link to the latest LXC image from the Nextcloudpi releases page and press "Download".

Optionally, you can copy the corresponding md5 sum from the releases page and paste it in the "Checksum" field to have Proxmox check that the downloaded image was not corrupted

2. Installer by tteck

Use the install script from tteck to install the LXC container on your Proxmox instance

He has multiple helper scripts available for Proxmox on his website, do go have a look if you're using Proxmox. 👍

Installation: bash -c "$(wget -qLO - https://github.com/tteck/Proxmox/raw/main/ct/nextcloudpi.sh)"

Default Settings: 2GB RAM - 8GB Storage - 2vCPU

(Check his website if this has changed and we haven't had the time to update it here yet, it's located under: Media - Photo > NextcloudPi LXC)

Thenk you tteck ❤️ for making the helper script & letting us use this for Proxmox installations 🙏

You can find his GitHub repository with his helper scripts here.

How to build

Packages

• apt-utils
• apt-transport-https
• build-essential
• binfmt-support
• binutils
• bzip2
• ca-certificates
• chroot
• cron
• curl
• dialog
• lsb-release
• jq
• git
• psmisc
• procps
• wget
• whiptail
• qemu
• qemu-user-static

Raspberry Pi IMG

git clone https://github.com/nextcloud/nextcloudpi.git
cd nextcloudpi
./build/build-SD-rpi.sh

Armbian-based board

./build-SD-armbian.sh odroidxu4   # supported board code name

LXD

./build/build-LXD.sh

NextcloudPi can be installed in any architecture running the latest Debian

Note: this assumes a clean Debian install, and there is no rollback method

Curl install scripts

This script will be executed as root, sudo is not necessary

# curl -sSL https://raw.githubusercontent.com/nextcloud/nextcloudpi/master/install.sh | bash

Environment variables for install.sh

Environment variables control the installation process.

When set to any value:

• CODE_DIR - sets the directory where the repo is stored locally, useful when it has been cloned manually
• NOUPDATE - do not run apt-get update for every single script
• SWAP - add swap explicitly
• KEEP_TAR - do not remove /var/www/nextcloud-${VER}.tar.bz2, useful when the script is re-run multiple times
• NCHOSTNAME - overrides the default NC hostname, defined in etc/ncp.cfg
• REINIT - re-initialise the configuration from scratch: drop NC database & user environment
• NCDATA - overrides the NC data directory, defined in etc/ncp-config.d/nc-datadir.cfg

NOTE: sudo -E is normally needed to gain root and to source non-root user environment but not required here

CODE_DIR=. NOUPDATE=1 NCHOSTNAME=my_own_hostname | bash install.sh

Also, for debug purposes:

• DBG=x - print commands and their arguments as they are executed.

Links

Website

Downloads

Nextcloud Forum

Nextcloud Forum Support

(Use the Forum for Support questions please, there's a NCP tag available, it will bridge your post to the Matrix and Telegram chats)

Contact

You can find us on the Forum, Telegram or Matrix