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.3KB

14 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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 authentification.
  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. […learn more about how to get support for Nextcloud here!](https://nextcloud.com/support)
  26. ## Contribution Guidelines
  27. All contributions to this repository from June, 16 2016 on are considered to be
  28. licensed under the AGPLv3 or any later version.
  29. Nextcloud doesn't require a CLA (Contributor License Agreement).
  30. The copyright belongs to all the individual contributors. Therefore we recommend
  31. that every contributor adds following line to the header of a file, if they
  32. changed it substantially:
  33. ```
  34. @copyright Copyright (c) <year>, <your name> (<your email address>)
  35. ```
  36. 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.
  37. Please review the [guidelines for contributing](https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md) to this repository.
  38. More information how to contribute: [https://nextcloud.com/contribute/](https://nextcloud.com/contribute/)
  39. ## Running master checkouts
  40. 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.
  41. Several apps by default included in regular releases like [firstrunwizard](https://github.com/nextcloud/firstrunwizard) or [gallery](https://github.com/nextcloud/gallery) are missing in `master` and have to be installed manually as required.
  42. That aside Git checkouts can be handled the same as release archives.
  43. Note they should never be used on production systems.