server README

The project's README from github.com/nextcloud/server. As one markdown file: README.md.

Nextcloud Server ☁

REUSE status codecov CII Best Practices Design

A safe home for all your data.

Why is this so awesome? 🤩

Do you want to learn more about how you can use Nextcloud to access, share, and protect your files, calendars, contacts, communication & more at home and in your organization? Learn about all our Features.

Get your Nextcloud 🚚

Enterprise? Public Sector or Education user? You may want to have a look into Nextcloud Enterprise provided by Nextcloud GmbH.

Get in touch 💬

You can also get support for Nextcloud!

Join the team 👪

There are many ways to contribute, of which development is only one! Find out how to get involved, including as a translator, designer, tester, helping others, and much more! 😍

Development setup 👩‍💻

  1. 🚀 Set up your local development environment
  2. 🐛 Pick a good first issue
  3. 👩‍🔧 Create a branch and make your changes. Remember to sign off your commits using git commit -sm "Your commit message"
  4. ⬆ Create a pull request and @mention the people from the issue to review
  5. 👍 Fix things that come up during a review
  6. 🎉 Wait for it to get merged!

Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking git submodule update --init or a similar command is needed, for details see Git documentation.

Several apps that are included by default in regular releases such as First run wizard or Activity are missing in master and have to be installed manually by cloning them into the apps subfolder.

Otherwise, git checkouts can be handled the same as release archives, by using the stable* branches. Note they should never be used on production systems.

Testing your code

We use multiple test frameworks for specific areas of the code:

For our end-to-end tests using Playwright you can refer to our documentation on how to debug errors and to contribute new test cases.

Tools we use 🛠

Helpful bots at GitHub :robot:

Ignore code style updates in git blame

git config blame.ignoreRevsFile .git-blame-ignore-revs

Contribution guidelines 📜

All contributions to this repository from June 16, 2016, and onward are considered to be licensed under the AGPLv3 or any later version.

Nextcloud doesn't require a CLA (Contributor License Agreement). The copyright belongs to all the individual contributors. Therefore we recommend that every contributor adds the following line to the AUTHORS file if they made substantial changes to the code:

- <your name> <your email address>

Please read the Code of Conduct. This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere and to explain how together we can strengthen and support each other.

Please review the guidelines for contributing to this repository.

More information on how to contribute: https://nextcloud.com/contribute/

server (nextcloud/server)

Searching Database…

37.1K ·GitHub
What is this?Nextcloud server is a self-hosted platform for storing, syncing, and sharing your files, contacts, calendars, and more, with hundreds of apps (Mail, Video Chat, etc.) to extend it.
Is this an app I install, or a hosted service?It is server software (PHP-based) you host yourself, buy preinstalled on hardware, or get from a hosting provider; it is not a single desktop app.
How do I get my own Nextcloud running?Sign up with one of the official providers, install the server yourself on your own hardware, buy a device with Nextcloud preinstalled, or use a hosting provider that runs it for you.
What do I need to run the dev environment?The repo targets Node ^24.0.0 and npm ^11.3.0 for the JS build, plus PHP for the server itself, and uses git submodules for third-party components that must be initialized separately.
Can I just run a master checkout in production?No — master checkouts are missing some default apps (like First Run Wizard or Activity) that must be cloned in manually, and master should never be used on production systems.
Is this meant for individuals or also organizations?It works for personal use at home as well as for organizations, with a separate Nextcloud Enterprise option for public sector, education, and enterprise customers.
How secure is my data on Nextcloud?Nextcloud offers encryption mechanisms, two-factor authentication, and runs a HackerOne bug bounty program to harden security.
What can I extend Nextcloud with?It supports hundreds of apps from the Nextcloud App Store, such as Calendar, Contacts, Mail, and Video Chat, to add features beyond core file storage.
How do I sync files across my devices?Nextcloud keeps your files, contacts, and calendars synchronized across all connected devices once stored on your server.
What test frameworks does the project use?PHPUnit for PHP unit tests, Behat for PHP integration tests, Vitest for JS/TypeScript unit tests, and Playwright for end-to-end tests.
How is Nextcloud related to ownCloud?Nextcloud is tagged alongside 'owncloud' in its topics, reflecting its origin as a fork/successor of the ownCloud project, though the README itself focuses on Nextcloud's own features.
Creator
nextcloud
Size
7 GB
Stars
37.1K
Age
10y
Commits · 90 Days