{"id":13506039,"url":"https://github.com/authzforce/fiware","last_synced_at":"2026-01-02T13:18:23.561Z","repository":{"id":142361856,"uuid":"43251801","full_name":"authzforce/fiware","owner":"authzforce","description":"FIWARE Generic Enabler for PDP/PAP support functions using an access control schema based on the XACML standard","archived":false,"fork":false,"pushed_at":"2024-02-07T01:45:20.000Z","size":43246,"stargazers_count":5,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-21T09:14:28.669Z","etag":null,"topics":["authzforce","fiware","pdp","security","xacml"],"latest_commit_sha":null,"homepage":"https://authzforce-ce-fiware.rtfd.io","language":"API Blueprint","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/authzforce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-09-27T15:23:12.000Z","updated_at":"2022-03-27T23:23:05.000Z","dependencies_parsed_at":"2024-11-01T04:31:32.297Z","dependency_job_id":"36685f9c-a541-4a39-8e27-b2b9642dd63a","html_url":"https://github.com/authzforce/fiware","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authzforce%2Ffiware","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authzforce%2Ffiware/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authzforce%2Ffiware/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/authzforce%2Ffiware/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/authzforce","download_url":"https://codeload.github.com/authzforce/fiware/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243602914,"owners_count":20317728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authzforce","fiware","pdp","security","xacml"],"created_at":"2024-08-01T01:00:33.548Z","updated_at":"2026-01-02T13:18:23.520Z","avatar_url":"https://github.com/authzforce.png","language":"API Blueprint","readme":"# FIWARE-specific documentation and Docker distribution\n\n[![FIWARE Security](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/security.svg)](https://www.fiware.org/developers/catalogue/)\n[![License: GPL v3](https://img.shields.io/github/license/authzforce/fiware.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![](https://img.shields.io/badge/tag-authzforce-orange.svg?logo=stackoverflow)](http://stackoverflow.com/questions/tagged/authzforce)\n[![Support badge]( https://img.shields.io/badge/support-ask.fiware.org-yellowgreen.svg)](https://ask.fiware.org/questions/scope:all/sort:activity-desc/tags:authzforce/)\n\u003cbr\u003e\n[![Documentation badge](https://readthedocs.org/projects/authzforce-ce-fiware/badge/?version=latest)](http://authzforce-ce-fiware.readthedocs.io/en/latest/?badge=latest)\n\nThis project is part of [FIWARE](https://www.fiware.org). More info on the [FIWARE catalogue](http://catalogue.fiware.org/enablers/authorization-pdp-authzforce).\n\nThis project provides the source of various FIWARE-specific documents to AuthzForce Server. AuthzForce Server is FIWARE Authorization PDP GEri (Generic Enabler Reference Implementation):\n- Technical specifications of the FIWARE Authorization PDP Generic Enabler (GE)'s API that AuthzForce implements in various forms:\n  - WADL and XML schemas (the reference);\n  - Apiary blueprint (the HTML output is available in [Apiary style](http://docs.authorizationpdp.apiary.io) and [FIWARE style](http://authzforce.github.io/fiware/) ).\n- The source of the GEri's documentation: Installation and Administration guide, User and Programmer Guide, etc. The generated documentation is available for each AuthzForce Server release as standalone HTML/PDF from the [Server release page](https://github.com/authzforce/server/releases), or online on [readthedocs.org](http://readthedocs.org/projects/authzforce-ce-fiware/versions/);\n- The source of the GEri's Docker image published in FIWARE Docker hub.\n\nThe actual source code of the GEri is in [server component's repository](https://github.com/authzforce/server).\n\n# How to generate the documentation\n\nCheckout this git repository, go to the `doc` directory of the local copy, then\nfor HTML output, run:\n\n```console\nmake clean html\n```\n\nFor PDF output, if you do it for the first time, install the requirements (instructions for Ubuntu 14.04+):\n\n```console\nsudo aptitude install texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra\n```\n\nThen run:\n\n```console\nmake clean latexpdf\n```\n\n# Release\n\nAfter any new release of AuthzForce server on authzforce/server repository, do the documentation release here as follows:\n\n1. Update `version` and `release` variables in [Sphinx configuration](doc/conf.py), to match the new AuthzForce server version.\n1. Update manuals: [Installation and Administration Guide](doc/InstallationAndAdministrationGuide.rst) and [User and Programmer's Guide](doc/UserAndProgrammersGuide.rst); especially version numbers when they occur.\n1. Test the updated documentation locally:\n   ```\n   $ pip install -r requirements.txt\n   $ make html\n   ```\n1. Update FILAB deployment scripts: [install.sh](filab.deploy/install.sh), [verif.sh](filab.deploy/verif.sh); especially the package version to match the new AuthzForce server version.\n1. Commit and push all changes\n1. Re-publish the Docker image on Docker Hub from [authzforce/server repository](https://hub.docker.com/r/authzforce/server/) to [fiware/authzforce-ce-server Docker repository](https://hub.docker.com/r/fiware/authzforce-ce-server/).\n1. Test the readthedocs.org HTML/PDF output by building the version *latest* from the [readthedocs.org repository](https://readthedocs.org/projects/authzforce-ce-fiware/builds/).\n1. After the readthedocs.org build is OK, create a release on Github with same tag name as the matching release of the AuthzForce [server](https://github.com/authzforce/server/releases/latest), e.g. `release-1.2.3`.\n1. Create a Docker tag in [build settings of authzforce-ce-server's Docker repository](https://hub.docker.com/r/fiware/authzforce-ce-server/) with the new release tag as *Name*, e.g. `release-1.2.3`, save changes and trigger the build.\n1. Trigger readthedocs.org to fetch the new release tag by updating something in the [authzforce-ce-fiware project Settings in Admin menu](https://readthedocs.org/dashboard/authzforce-ce-fiware/edit/) such as the *Description*.\n1. In the *Versions* sub-menu of *Admin* on this readthedocs.org repository, you should now see the new tag/version. Check the *Active* checkbox next to it and click *Submit*.\n1. In the *Builds* menu on the readthedocs.org repository, select the new version and click the *Build version:* button. The build is triggered and added to the queue. Wait until the status changes to *Passed*.\n\n\n# Hotfix\nIf you need to fix things on a release, create a hotfix release by adding/incrementing a letter as suffix to the AuthzForce server version, e.g. `1.2.3a` would be the first documentation fix for AuthzForce version `1.2.3` (the tag would be `release-1.2.3a`), `1.2.3b` would be the second hotfix, etc.\n","funding_links":[],"categories":["FIWARE Catalogue"],"sub_categories":["Security"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauthzforce%2Ffiware","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fauthzforce%2Ffiware","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauthzforce%2Ffiware/lists"}