{"id":13405961,"url":"https://github.com/nextcloud/nextcloudpi","last_synced_at":"2025-04-10T10:46:47.114Z","repository":{"id":39083137,"uuid":"81749801","full_name":"nextcloud/nextcloudpi","owner":"nextcloud","description":"📦 Build code for NextcloudPi: Raspberry Pi, Odroid, Rock64, curl installer...","archived":false,"fork":false,"pushed_at":"2024-10-25T00:57:35.000Z","size":9650,"stargazers_count":2541,"open_issues_count":196,"forks_count":298,"subscribers_count":77,"default_branch":"master","last_synced_at":"2024-10-29T15:19:33.887Z","etag":null,"topics":["arm","nextcloud","qemu","raspberry-pi","raspbian","x86-64"],"latest_commit_sha":null,"homepage":"https://nextcloudpi.com","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nextcloud.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":"CONTRIBUTING.md","funding":"FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"thecalcaholic","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2017-02-12T19:11:16.000Z","updated_at":"2024-10-29T01:03:18.000Z","dependencies_parsed_at":"2023-11-09T13:27:53.422Z","dependency_job_id":"658caa70-7e14-4040-8c11-74b43f37d5b4","html_url":"https://github.com/nextcloud/nextcloudpi","commit_stats":{"total_commits":1753,"total_committers":69,"mean_commits":"25.405797101449274","dds":"0.37079292641186534","last_synced_commit":"29e6c05937b4d99b76b77d6469e07e3aa59bf51d"},"previous_names":[],"tags_count":910,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fnextcloudpi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fnextcloudpi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fnextcloudpi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fnextcloudpi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nextcloud","download_url":"https://codeload.github.com/nextcloud/nextcloudpi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248201666,"owners_count":21064169,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arm","nextcloud","qemu","raspberry-pi","raspbian","x86-64"],"created_at":"2024-07-30T19:02:17.110Z","updated_at":"2025-04-10T10:46:47.093Z","avatar_url":"https://github.com/nextcloud.png","language":"Shell","readme":"English | [Traditional Chinese 繁體中文](i18n/README-zh_TW.md) | [Simplified Chinese 简体中文](i18n/README-zh_CN.md)\n\n_(The translated README pages are not updated at this time)_\n\n# NextcloudPi\n\n[![Telegram icon][telegram-badge]][chat-telegram] [![Matrix icon][matrix-badge]][chat-matrix]  [![Nextcloud icon][nc-badge]][nc-github]\n\n[![Forum icon][forum-badge]][nc-forum-support]\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/nextcloud/nextcloudpi/blob/master/ncp-app/img/app.svg\"\n       width=\"120\"\n       height=\"85\"\n       alt=\"NextcloudPi logo\"\u003e\n\u003c/p\u003e\n\nThis is the build code for the [NextcloudPi][ncp-website] open-source community project.\n\nNextcloudPi is a ready to use image for Virtual Machines, Raspberry Pi, Odroid HC1, Rock64 and other boards. ([⇒ Downloads][ncp-releases])\n\nThis code also generates the NextcloudPi LXD and LXC containers and there is an install script for the latest supported Debian based system as well.\n\nFind the documentation at [docs.nextcloudpi.com][ncp-docs-website], the documentation is all written by volunteers.\n\nPlease reach out in the [Matrix][chat-matrix-wiki] or [Telegram][chat-telegram-wiki] Wiki group chats if you want to help out to keep them up-to-date and we'll add you to the [Wiki Group][nc-forum-wiki-group] on the [forum][nc-forum].\n\n---\n\n### Test Status\n\n`master`\n\n[![Release](https://github.com/nextcloud/nextcloudpi/actions/workflows/release.yml/badge.svg)](https://github.com/nextcloud/nextcloudpi/actions/workflows/release.yml)\n\n`devel`\n\n[![Release](https://github.com/nextcloud/nextcloudpi/actions/workflows/release.yml/badge.svg?branch=devel)](https://github.com/nextcloud/nextcloudpi/actions/workflows/release.yml)\n\n---\n\n## Features\n\n * Raspberry Pi OS/Debian 12 _(Bookworm)_\n * Nextcloud\n * Apache, with HTTP2 enabled\n * PHP 8.1\n * MariaDB\n * Redis memory cache\n * ncp-config TUI for easy setup ( RAM logs, USB drive and more )\n * Automatic redirection to HTTPS\n * APCu PHP cache\n * PHP Zend OPcache enabled with file cache\n * HSTS\n * Cron jobs for Nextcloud\n * Sane configuration defaults\n * Full emoji support\n * Postfix email\n * Secure\n\n## Extras\n\n * Setup wizard\n * NextcloudPi Web Panel\n * Wi-Fi ready\n * Ram logs\n * Automatic security updates, activated by default.\n * Let’s Encrypt for trusted HTTPS certificates.\n * Fail2Ban protection against brute force attacks.\n * UFW firewall\n * Dynamic DNS support for no-ip.org\n * Dynamic DNS support for freeDNS\n * Dynamic DNS support for duckDNS\n * Dynamic DNS support for spDYN\n * Dynamic DNS support for Namecheap\n * dnsmasq DNS server with DNS cache\n * ModSecurity Web Application Firewall\n * NFS ready to mount your files over LAN\n * SAMBA ready to share your files with Windows/Mac/Linux\n * USB automount\n * Remote updates\n * Automatic NCP updates\n * Automatic Nextcloud updates\n * Update notifications\n * Nextcloud backup and restore\n * Nextcloud online installation\n * Format USB drive to BTRFS\n * BTRFS snapshots\n * Automatic BTRFS snapshots\n * BTRFS snapshot auto sync\n * scheduled rsync\n * UPnP automatic port forwarding\n * Security audits with Lynis and Debsecan\n * ZRAM\n * SMART hard drive health monitoring\n\nExtras can be activated and configured using the web interface at HTTPS port 4443\n\n![ncp-web][ncp-web-image]\n\nOr from the command line using\n\n```\nsudo ncp-config\n```\n\n![NCP-config][ncp-config-image]\n\n## Docker has been discontinued\n\nDocker 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\n\n## Run in LXD\n\n```\n# Imports the LXC image, replace the X's with version number\nlxc image import \"NextcloudPi_LXD_vX.XX.X.tar.gz\" --alias \"nextcloudpi\"\n\n# Launches a container from the image\nlxc launch \"nextcloudpi\" ncp\n\n# Starts the container you've launched from the imported image\nlxc start ncp\n```\n\n## Run in Proxmox\n\nThere are two ways to run NCP on Proxmox:\n\n### 1. Using the official release image\n\nIn your Proxmox web interface, head to any storage pool that has CT Templates enabled, go to CT Templates, \nclick \"Download from URL\" and enter the link to the latest LXC image from the [Nextcloudpi releases page](https://github.com/nextcloud/nextcloudpi/releases)\nand press \"Download\".\n\n\u003cimg height=\"300\" alt=\"Download from URL dialog\" src=\"https://nextcloudpi.com/images/ncp-proxmox-download-screenshot.png\"\u003e\n\nOptionally, you can copy the corresponding md5 sum from the releases page and paste it in the \"Checksum\" field to have\nProxmox check that the downloaded image was not corrupted\n\n### 2. Installer by tteck\n\nUse the [install script][ncp-proxmox-install-script-v5] from [tteck][tteck-profile] to install the LXC container on your Proxmox instance\n\nHe has multiple helper scripts available for Proxmox on his [website][website-helper-scripts], do go have a look if you're using Proxmox. :+1:\n\nInstallation: `bash -c \"$(wget -qLO - https://github.com/tteck/Proxmox/raw/main/ct/nextcloudpi.sh)\"`\n\nDefault Settings: `2GB RAM - 8GB Storage - 2vCPU`\n\n_(Check his [website][website-helper-scripts] if this has changed and we haven't had the time to update it here yet, it's located under: Media - Photo \u003e NextcloudPi LXC)_\n\nThenk you [tteck][tteck-profile] :heart: for making the helper script \u0026 letting us use this for Proxmox installations :pray:\n\nYou can find his GitHub repository with his helper scripts [here][gh-helper-scripts-repo].\n\n## How to build\n\nPackages\n\n- `apt-utils`\n- `apt-transport-https`\n- `build-essential`\n- `binfmt-support`\n- `binutils`\n- `bzip2`\n- `ca-certificates`\n- `chroot`\n- `cron`\n- `curl`\n- `dialog`\n- `lsb-release`\n- `jq`\n- `git`\n- `psmisc`\n- `procps`\n- `wget`\n- `whiptail`\n- `qemu`\n- `qemu-user-static`\n\n### Raspberry Pi IMG\n\n```\ngit clone https://github.com/nextcloud/nextcloudpi.git\ncd nextcloudpi\n./build/build-SD-rpi.sh\n```\n\n### Armbian-based board\n\n```\n./build-SD-armbian.sh odroidxu4   # supported board code name\n```\n\n### LXD\n\n```\n./build/build-LXD.sh\n```\n\nNextcloudPi can be installed in any architecture running the latest Debian\n\n_Note: this assumes a clean Debian install, and there is no rollback method_\n\n### Curl install scripts\n\nThis is executed as `root` as indicated by the `#`\n\n```\n# curl -sSL https://raw.githubusercontent.com/nextcloud/nextcloudpi/master/install.sh | bash\n```\n\nIf you're not `root` you can run it with `sudo` like so\n\n```\ncurl -sSL https://raw.githubusercontent.com/nextcloud/nextcloudpi/master/install.sh | sudo bash\n```\n\n## Links\n\n[Website][ncp-website]\n\n[Downloads][ncp-releases]\n\n\u003c!-- [Docker Hub][ncp-docker-hub] --\u003e\n\n[Nextcloud Forum][nc-forum]\n\n[Nextcloud Forum Support][nc-forum-support]\n\n_(Use the Forum for Support questions please, there's a NCP tag available, it will bridge your post to the Matrix and Telegram chats)_\n\n## Contact\n\nYou can find us on the [Forum][nc-forum], [Telegram][chat-telegram] or [Matrix][chat-matrix]\n\n\u003c!-- LINKS --\u003e\n\n[ncp-website]: https://nextcloudpi.com\n\n[ncp-docs-website]: http://docs.nextcloudpi.com\n\n[ncp-docker-hub]: https://hub.docker.com/r/ownyourbits/nextcloudpi\n\n[ncp-releases]: https://github.com/nextcloud/nextcloudpi/releases\n\n[nc-github]: https://github.com/nextcloud\n\n\u003c!-- FORUM --\u003e\n\n[nc-forum]: https://help.nextcloud.com/\n\n[nc-forum-support]: https://help.nextcloud.com/c/support/appliances-docker-snappy-vm\n\n[nc-forum-wiki-group]: https://help.nextcloud.com/g/NCP_Wiki_Team/members\n\n\u003c!-- CHAT --\u003e\n\n[chat-matrix]: https://matrix.to/#/#nextcloudpi:matrix.org\n\n[chat-matrix-wiki]: https://matrix.to/#/#NCP_Wiki_Team:matrix.org\n\n[chat-telegram]: https://t.me/NextcloudPi\n\n[chat-telegram-wiki]: https://t.me/NCP_Wiki_Team\n\n\u003c!-- TESTS --\u003e\n\n[vm-tests]: https://github.com/nextcloud/nextcloudpi/actions/workflows/vm-tests.yml\n\n[docker-tests]: https://github.com/nextcloud/nextcloudpi/actions/workflows/build-docker.yml\n\n\u003c!-- BADGES --\u003e\n\n[gh-vm-tests-badge]: https://github.com/nextcloud/nextcloudpi/actions/workflows/vm-tests.yml/badge.svg\n\n[gh-docker-tests-badge]: https://github.com/nextcloud/nextcloudpi/actions/workflows/build-docker.yml/badge.svg\n\n[gh-vm-tests-badge-devel]: https://github.com/nextcloud/nextcloudpi/actions/workflows/vm-tests.yml/badge.svg?branch=devel\n\n[gh-docker-tests-badge-devel]: https://github.com/nextcloud/nextcloudpi/actions/workflows/build-docker.yml/badge.svg?branch=devel\n\n[vm-tests-badge]: https://github.com/nextcloud/nextcloudpi/workflows/VM%20Integration%20Tests/badge.svg\n\n[docker-tests-badge]: https://github.com/nextcloud/nextcloudpi/actions/workflows/build-docker.yml/badge.svg\n\n[telegram-badge]: https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\u0026logo=telegram\u0026logoColor=white\n\n[matrix-badge]: https://img.shields.io/badge/matrix-000000?style=for-the-badge\u0026logo=Matrix\u0026logoColor=white\n\n[forum-badge]: https://img.shields.io/badge/help-forums-blue.svg\n\n[nc-badge]: https://img.shields.io/badge/Nextcloud-0082C9?style=for-the-badge\u0026logo=Nextcloud\u0026logoColor=white\n\n\u003c!-- TTECK --\u003e\n\n[tteck-profile]: https://github.com/tteck\n\n[gh-helper-scripts-repo]: https://github.com/tteck/Proxmox\n\n[website-helper-scripts]: https://tteck.github.io/Proxmox/\n\n[ncp-proxmox-install-script-v5]: https://github.com/tteck/Proxmox/blob/main/install/nextcloudpi-v5-install.sh\n\n\u003c!-- IMAGES --\u003e\n\n[ncp-web-image]: https://user-images.githubusercontent.com/21343324/136853829-f4e99ec0-6307-431f-b4c7-21b2330cae7f.png\n\n[ncp-config-image]: https://help.nextcloud.com/uploads/default/original/3X/b/3/b3d157022a32296ab54428b14b5df02104a91f18.png\n\n\u003c!-- EXTRAS \u0026 BACKUPS\n\n[telegram-badge]: https://patrolavia.github.io/telegram-badge/chat.png\n\n[rpi-badge]: https://img.shields.io/badge/Raspberry%20Pi-A22846?style=for-the-badge\u0026logo=Raspberry%20Pi\u0026logoColor=white\n\n[linux-badge]: https://img.shields.io/badge/Linux-FCC624?style=for-the-badge\u0026logo=linux\u0026logoColor=black\n\n[debian-badge]: https://img.shields.io/badge/Debian-A81D33?style=for-the-badge\u0026logo=debian\u0026logoColor=white\n\n[gh-badge]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge\u0026logo=github\u0026logoColor=white\n\n--\u003e\n","funding_links":["https://ko-fi.com/thecalcaholic"],"categories":["Shell","Software","HarmonyOS","raspberry-pi","Apps","OS Images"],"sub_categories":["Self-hosting Solutions","Windows Manager","Container"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnextcloud%2Fnextcloudpi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnextcloud%2Fnextcloudpi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnextcloud%2Fnextcloudpi/lists"}