From dbffc60ea8092af2e6c1c49f9863a0677a0a161a Mon Sep 17 00:00:00 2001 From: 12ww1160 Date: Fri, 12 Dec 2025 16:38:37 +0100 Subject: [PATCH] OP#254 add Readme and license --- LICENSE | 16 ++++++++ README.md | 110 +++++++++++++----------------------------------------- 2 files changed, 42 insertions(+), 84 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1ee42fd --- /dev/null +++ b/LICENSE @@ -0,0 +1,16 @@ +Creative Commons Attribution-NonCommercial-NoDerivatives + +You are free to: +Share — copy and redistribute the material in any medium or format +The licensor cannot revoke these freedoms as long as you follow the license terms. +Under the following terms: +Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. +NonCommercial — You may not use the material for commercial purposes. +NoDerivatives — If you remix, transform, or build upon the material, you may not distribute the modified material. +No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. +Notices: +You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation. + +No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material. + +The full legal text of the license is available at https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode. \ No newline at end of file diff --git a/README.md b/README.md index 234f104..caa9d73 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,35 @@ -# confdroid-package-management +# Readme +This repository hosts the public GPG key used for signing RPM packages provided by [Your Project Name]. The key is made available for users to import and verify the authenticity and integrity of our distributed RPMs. +## Purpose +- **Public GPG Key Distribution**: The primary file here is `RPM-GPG-KEY-[yourproject].asc`, which you can import to trust and verify RPM packages from our forge or repository. +- This repo is public to allow easy access to the key via a direct URL. For the actual RPM packages, refer to our main project repository or download site at [link to your RPM repo or forge page, e.g., https://github.com/yourusername/your-rpm-repo/releases]. -## Getting started +## How to Import the GPG Key +To verify our RPM packages, import this public key on your system. Use the direct raw URL for the key file. -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +### Via Command Line (Recommended for RPM-based systems like Fedora, RHEL, CentOS) +1. Import the key: -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +```bash + sudo rpm --import https://gitea.confdroid.com/confdroid/confdroid-package-management/src/branch/master/keys/RPM-GPG-KEY-public.asc + ``` -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command: +2. Verify an RPM package after download: +```bash + rpm --checksig path/to/your-package.rpm ``` -cd existing_repo -git remote add origin https://gitlab.confdroid.com/internal/confdroid-package-management.git -git branch -M master -git push -uf origin master +It should report "OK" if the signature matches. + +### Via GPG (For manual verification or non-RPM systems) +1. Download the key: + +```bash + curl -O https://gitea.confdroid.com/confdroid/confdroid-package-management/src/branch/master/keys/RPM-GPG-KEY-public.asc +``` +2. To fetch from a keyserver (if published): +```bash + gpg --keyserver keys.openpgp.org --recv-keys 3. To fetch from a keyserver (if published): ``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.confdroid.com/internal/confdroid-package-management/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.