You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 4.4KB

14 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. # Nextcloud Server
  2. [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/server/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/server/?branch=master)
  3. [![codecov](https://codecov.io/gh/nextcloud/server/branch/master/graph/badge.svg)](https://codecov.io/gh/nextcloud/server)
  4. [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/209/badge)](https://bestpractices.coreinfrastructure.org/projects/209)
  5. [![irc](https://img.shields.io/badge/IRC-%23nextcloud%20on%20freenode-orange.svg)](https://webchat.freenode.net/?channels=nextcloud)
  6. [![irc](https://img.shields.io/badge/IRC-%23nextcloud--dev%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=nextcloud-dev)
  7. **A safe home for all your data.**
  8. ![](https://github.com/nextcloud/screenshots/blob/master/files/filelist.png)
  9. ## Why is this so awesome?
  10. * :file_folder: **Access your Data** You can store your files, contacts, calendars and more on a server of your choosing.
  11. * :package: **Sync your Data** You keep your files, contacts, calendars and more synchronized amongst your devices.
  12. * :arrows_counterclockwise: **Share your Data** …by giving others access to the stuff you want them to see or to collaborate with.
  13. * :rocket: **Expandable with dozens of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail) and all those you can discover in our [App Store](https://apps.nextcloud.com)
  14. * :lock: **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication.
  15. *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 at your Enterprise?* [**Learn about all our Features**](https://nextcloud.com/features).
  16. ## Get your Nextcloud
  17. - [**Install** a server by yourself on your own hardware or by using one of our ready to use **Appliances**](https://nextcloud.com/install/#instructions-server)
  18. - [Buy one of the awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/)
  19. - [Find a service **provider** who is hosting Nextcloud for you or your company](https://nextcloud.com/providers/)
  20. *Enterprise? Public Sector or Education user? You may want to have a look into the [**Enterprise Support Subscription**](https://nextcloud.com/enterprise/) provided by the Nextcloud GmbH*
  21. ## Get in touch
  22. * :clipboard: [Forum](https://help.nextcloud.com)
  23. * :busts_in_silhouette: [Facebook](https://facebook.com/nextclouders)
  24. * :hatching_chick: [Twitter](https://twitter.com/Nextclouders)
  25. * :elephant: [Mastodon](https://mastodon.xyz/@nextcloud)
  26. […learn more about how to get support for Nextcloud here!](https://nextcloud.com/support)
  27. ## Contribution Guidelines
  28. All contributions to this repository from June, 16 2016 on are considered to be
  29. licensed under the AGPLv3 or any later version.
  30. Nextcloud doesn't require a CLA (Contributor License Agreement).
  31. The copyright belongs to all the individual contributors. Therefore we recommend
  32. that every contributor adds following line to the header of a file, if they
  33. changed it substantially:
  34. ```
  35. @copyright Copyright (c) <year>, <your name> (<your email address>)
  36. ```
  37. Please read the [Code of Conduct](https://nextcloud.com/community/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.
  38. Please review the [guidelines for contributing](https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md) to this repository.
  39. More information how to contribute: [https://nextcloud.com/contribute/](https://nextcloud.com/contribute/)
  40. ## Running master checkouts
  41. 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.
  42. Several apps that are included by default in regular releases such as [firstrunwizard](https://github.com/nextcloud/firstrunwizard) or [gallery](https://github.com/nextcloud/gallery) are missing in `master` and have to be installed manually.
  43. That aside Git checkouts can be handled the same as release archives.
  44. Note they should never be used on production systems.