Skip to content

README.md

Latest commit

 

History

History
127 lines (82 loc) · 5.06 KB

README.md

File metadata and controls

127 lines (82 loc) · 5.06 KB
Raw

Notes

License ownCloud OSPO Docker Hub

A distraction-free note-taking app for ownCloud Server that stores notes as plain text files in the user's cloud storage. It provides a clean web-based editor with a RESTful API for third-party app integration, enabling mobile and desktop note clients to sync notes through ownCloud.

Getting Started

Follow the steps below to install and enable the Notes app.

Prerequisites

  • ownCloud Server 8.1+
  • PHP 5.4+

Installation

Clone into your ownCloud apps directory and enable:

git clone https://github.com/owncloud/notes.git /var/www/owncloud/apps/notes
occ app:enable notes

Build

make build

Run Tests

make test-php-unit
make test-php-style

Documentation

Part of ownCloud Server (Classic)

This app is a plugin for ownCloud Server 10 (version 8.1+). Install it from the ownCloud Marketplace or directly from the repository.

This component is included in the ownCloud Server Docker image.

Community & Support

Star this repo and Watch for release notifications!

Contributing

We welcome contributions! Please read the Contributing Guidelines and our Code of Conduct before getting started.

Workflow

  • Rebase Early, Rebase Often! We use a rebase workflow. Always rebase on the target branch before submitting a PR.
  • Dependabot: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly.
  • Signed Commits: All commits must be PGP/GPG signed. See GitHub's signing guide.
  • DCO Sign-off: Every commit must carry a Signed-off-by line: 
    git commit -s -S -m "your commit message"
  • GitHub Actions Policy: Workflows may only use actions that are (a) owned by owncloud, (b) created by GitHub (actions/*), or (c) verified in the GitHub Marketplace.

Translations

Help translate this project on Transifex: https://explore.transifex.com/owncloud-org/owncloud/

Please submit translations via Transifex -- do not open pull requests for translation changes.

Security

Do not open a public GitHub issue for security vulnerabilities.

Report vulnerabilities at https://security.owncloud.com -- see SECURITY.md.

Bug bounty: YesWeHack ownCloud Program

License

This project is licensed under the AGPL-3.0.

About the ownCloud OSPO

The Kiteworks Open Source Program Office, operating under the ownCloud brand, launched on May 5, 2026, to steward the open source ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, community health, and sustainable collaboration between the open source community and Kiteworks, which acquired ownCloud in 2023.

For questions about the OSPO or licensing, contact ospo@kiteworks.com.

License Migration to Apache 2.0

The OSPO is driving a strategic relicensing of ownCloud repositories toward the Apache License 2.0, following the Apache Software Foundation's third-party license policy.

Individual repositories will migrate as their audit is completed. The LICENSE file in each repo reflects its current license status (not the target).

Current license: AGPL-3.0 (Category X per Apache policy -- cannot be included in Apache-2.0 works).

Migration prerequisites for this repository:

  • CLA/DCO coverage: All past contributors must have signed agreements permitting relicensing
  • Copyleft dependency audit: All AGPL/GPL dependencies must be replaced or isolated
  • KDE heritage review: Any code with KDE-era copyrights requires legal analysis
  • Complete relicensing: AGPL-3.0 is a strong copyleft license; migration requires full relicensing of all files, not just a header change