diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 123 |
1 files changed, 85 insertions, 38 deletions
diff --git a/README.md b/README.md index 63ba04031b0..5813da701f7 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,97 @@ -# ownCloud Core +<!-- + - SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + - SPDX-FileCopyrightText: 2013-2016 ownCloud, Inc. + - SPDX-License-Identifier: AGPL-3.0-or-later +--> +# Nextcloud Server ☁ +[](https://api.reuse.software/info/github.com/nextcloud/server) +[](https://codecov.io/gh/nextcloud/server) +[](https://bestpractices.coreinfrastructure.org/projects/209) +[](https://contribute.design/nextcloud/server) -[](https://ci.owncloud.org/job/server-master-linux/) -[](https://scrutinizer-ci.com/g/owncloud/core/) -[](https://codecov.io/github/owncloud/core?branch=master) -[](https://codeclimate.com/github/owncloud/core) -[](https://scan.coverity.com/projects/owncloud-core) -[](https://www.versioneye.com/user/projects/54f4a2384f3108959a000a16) -[](https://www.versioneye.com/user/projects/54d1f76f3ca0840b190000c0) +**A safe home for all your data.** - + -**[ownCloud](http://ownCloud.org) gives you freedom and control over your own data. -A personal cloud which runs on your own server.** +## Why is this so awesome? 🤩 - +* 📁 **Access your Data** You can store your files, contacts, calendars, and more on a server of your choosing. +* 🔄 **Sync your Data** You keep your files, contacts, calendars, and more synchronized amongst your devices. +* 🙌 **Share your Data** …by giving others access to the stuff you want them to see or to collaborate with. +* 🚀 **Expandable with hundreds of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail), [Video Chat](https://github.com/nextcloud/spreed) and all those you can discover in our [App Store](https://apps.nextcloud.com) +* 🔒 **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication. -## Why is this so awesome? -* :file_folder: **Access your Data** You can store your files, contacts, calendars and more on a server of your choosing. -* :package: **Sync your Data** You keep your files, contacts, calendars and more synchronized amongst your devices. -* :arrows_counterclockwise: **Share your Data** You share your data with others, and give them access to your latest photo galleries, your calendar or anything else you want them to see. -* :rocket: **Expandable with dozens of Apps** ...like Calendar, Contacts, Mail or News. -* :cloud: **All Benefits of the Cloud** ...on your own Server. -* :lock: **Encryption** You can encrypt data in transit with secure https connections. You can enable the encryption app to encrypt data on storage for improved security and privacy. -* ... +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**](https://nextcloud.com/athome/). -## Installation instructions -https://doc.owncloud.org/server/9.0/developer_manual/app/index.html +## Get your Nextcloud 🚚 -## Contribution Guidelines -https://owncloud.org/contribute/ +- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) at one of our providers either through our website or through the apps directly. +- 🖥 [**Install** a server by yourself](https://nextcloud.com/install/#instructions-server) on your hardware or by using one of our ready-to-use **appliances** +- 📦 Buy one of the [awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/) +- 🏢 Find a [service **provider**](https://nextcloud.com/providers/) who hosts Nextcloud for you or your company -## Support -Learn about the different ways you can get support for ownCloud: https://owncloud.org/support/ +Enterprise? Public Sector or Education user? You may want to have a look into [**Nextcloud Enterprise**](https://nextcloud.com/enterprise/) provided by Nextcloud GmbH. -## Get in touch -* :clipboard: [Forum](https://forum.owncloud.org) -* :envelope: [Mailing list](https://mailman.owncloud.org/mailman/listinfo) -* :hash: [IRC channel](https://webchat.freenode.net/?channels=owncloud) -* :busts_in_silhouette: [Facebook] (https://facebook.com/ownclouders) -* :hatching_chick: [Twitter](https://twitter.com/ownClouders) +## Get in touch 💬 -## Important notice on translations -Please submit translations via Transifex: -https://www.transifex.com/projects/p/owncloud/ +* [📋 Forum](https://help.nextcloud.com) +* [👥 Facebook](https://www.facebook.com/nextclouders) +* [🐣 Twitter](https://twitter.com/Nextclouders) +* [🐘 Mastodon](https://mastodon.xyz/@nextcloud) -[](https://www.transifex.com/projects/p/owncloud/) +You can also [get support for Nextcloud](https://nextcloud.com/support)! -For more detailed information about translations: -http://doc.owncloud.org/server/9.0/developer_manual/core/translation.html + +## Join the team 👪 + +There are many ways to contribute, of which development is only one! Find out [how to get involved](https://nextcloud.com/contribute/), including as a translator, designer, tester, helping others, and much more! 😍 + + +### Development setup 👩💻 + +1. 🚀 [Set up your local development environment](https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html) +2. 🐛 [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) +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](https://opensource.guide/how-to-contribute/#opening-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](https://github.com/nextcloud/firstrunwizard) or [Activity](https://github.com/nextcloud/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. + + +### Tools we use 🛠 + +- [👀 BrowserStack](https://browserstack.com) for cross-browser testing +- [🌊 WAVE](https://wave.webaim.org/extension/) for accessibility testing +- [🚨 Lighthouse](https://developers.google.com/web/tools/lighthouse/) for testing performance, accessibility, and more + +#### Helpful bots at GitHub :robot: + +- Comment on a pull request with `/update-3rdparty` to update the 3rd party submodule. It will update to the last commit of the 3rd party branch named like the PR target. + +#### 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](AUTHORS) file if they made substantial changes to the code: + +``` +- <your name> <your email address> +``` + +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. + +Please review the [guidelines for contributing](.github/CONTRIBUTING.md) to this repository. + +More information on how to contribute: [https://nextcloud.com/contribute/](https://nextcloud.com/contribute/) |