diff --git a/PUBLISHING.md b/PUBLISHING.md index 3d40ad351c..ae6afaea90 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -124,7 +124,7 @@ Include a PR for this soon-to-be PR. You can guess at the number of the PR by us 11. New images for the release are automatically published by the GitHubAction Workflows: [publish.yml] and [publish-indy.yml]. The actions are triggered when a release is tagged, so no manual action is needed. The images are - published in the [Hyperledger Package Repository under + published in the [OpenWallet Foundation Package Repository under acapy](https://github.com/openwallet-foundation/packages?repo_name=acapy) and a link to the packages added to the repositories main page (under "Packages"). @@ -133,7 +133,7 @@ Include a PR for this soon-to-be PR. You can guess at the number of the PR by us found in the document [Container Images and Github Actions](docs/deploying/ContainerImagesAndGithubActions.md). In addition, the published documentation site [https://aca-py.org] should be automatically updated to include the new release via the [publish-docs] GitHub Action. - Additional information about that process and some related maintainance activities that are needed from time to time can be found in the [Updating the ACA-Py Documentation Site] document. + Additional information about that process and some related maintenance activities that are needed from time to time can be found in the [Updating the ACA-Py Documentation Site] document. [publish.yml]: https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish.yml [publish-indy.yml]: https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish-indy.yml diff --git a/docs/demo/Aries-Workshop.md b/docs/demo/ACA-Py-Workshop.md similarity index 100% rename from docs/demo/Aries-Workshop.md rename to docs/demo/ACA-Py-Workshop.md diff --git a/docs/demo/AliceGetsAPhone.md b/docs/demo/AliceGetsAPhone.md index 59fedb108a..61eaafc08f 100644 --- a/docs/demo/AliceGetsAPhone.md +++ b/docs/demo/AliceGetsAPhone.md @@ -44,8 +44,8 @@ Of course for this, you need to have a mobile agent. To find, install and setup Open a new bash shell and in a project directory run the following: ```bash -git clone https://github.com/hyperledger/aries-cloudagent-python.git -cd aries-cloudagent-python/demo +git clone https://github.com/openwallet-foundation/acapy.git +cd acapy/demo ``` We'll come back to this in a minute, when we start the `faber` agent! @@ -94,8 +94,8 @@ To run the necessary terminal sessions in your browser, go to the Docker playgro Open a new bash shell and in a project directory run the following: ```bash -git clone https://github.com/hyperledger/aries-cloudagent-python.git -cd aries-cloudagent-python/demo +git clone https://github.com/openwallet-foundation/acapy.git +cd acapy/demo ``` We'll come back to this in a minute, when we start the `faber` agent! diff --git a/docs/demo/AriesOpenAPIDemo.md b/docs/demo/OpenAPIDemo.md similarity index 99% rename from docs/demo/AriesOpenAPIDemo.md rename to docs/demo/OpenAPIDemo.md index b43bb72737..4778b0f06a 100644 --- a/docs/demo/AriesOpenAPIDemo.md +++ b/docs/demo/OpenAPIDemo.md @@ -69,8 +69,8 @@ To run the necessary terminal sessions in your browser, go to the Docker playgro In a browser, go to the [Play with Docker](https://labs.play-with-docker.com/) home page, Login (if necessary) and click "Start." On the next screen, click (in the left menu) "+Add a new instance." That will start up a terminal in your browser. Run the following commands to start the Faber agent. ```bash -git clone https://github.com/hyperledger/aries-cloudagent-python -cd aries-cloudagent-python/demo +git clone https://github.com/openwallet-foundation/acapy +cd acapy/demo LEDGER_URL=http://test.bcovrin.vonx.io ./run_demo faber --events --no-auto --bg ``` @@ -97,8 +97,8 @@ Once the Faber agent has started up (with the invite displayed), click the link Now to start Alice's agent. Click the "+Add a new instance" button again to open another terminal session. Run the following commands to start Alice's agent: ```bash -git clone https://github.com/hyperledger/aries-cloudagent-python -cd aries-cloudagent-python/demo +git clone https://github.com/openwallet-foundation/acapy +cd acapy/demo LEDGER_URL=http://test.bcovrin.vonx.io ./run_demo alice --events --no-auto --bg ``` @@ -135,8 +135,8 @@ To begin running the demo in Docker, open up two terminal windows, one each for In the first terminal window, clone the ACA-Py repo, change into the demo folder and start the Faber agent: ```bash -git clone https://github.com/hyperledger/aries-cloudagent-python -cd aries-cloudagent-python/demo +git clone https://github.com/openwallet-foundation/acapy +cd acapy/demo LEDGER_URL=http://test.bcovrin.vonx.io ./run_demo faber --events --no-auto --bg ``` diff --git a/docs/demo/AriesPostmanDemo.md b/docs/demo/PostmanDemo.md similarity index 100% rename from docs/demo/AriesPostmanDemo.md rename to docs/demo/PostmanDemo.md diff --git a/docs/demo/README.md b/docs/demo/README.md index 49b65e9ae4..df4db54819 100644 --- a/docs/demo/README.md +++ b/docs/demo/README.md @@ -21,7 +21,6 @@ There are several demos available for ACA-Py mostly (but not only) aimed at deve - [Revocation](#revocation) - [DID Exchange](#did-exchange) - [Endorser](#endorser) - - [Run Indy-SDK Backend](#run-indy-sdk-backend) - [Mediation](#mediation) - [Multi-ledger](#multi-ledger) - [Multi-tenancy](#multi-tenancy) @@ -279,14 +278,6 @@ With DID Exchange, you can also enable use of the inviter's public DID for invit This is described in [Endorser.md](Endorser.md) -### Run Indy-SDK Backend - -This runs using the older (and not recommended) indy-sdk libraries instead of [Aries Askar](https://github.com/hyperledger/aries-ask): - -```bash -./run_demo faber --wallet-type indy -``` - ### Mediation To enable mediation, run the `alice` or `faber` demo with the `--mediation` option: @@ -444,7 +435,7 @@ The controllers for this demo can be found in the [alice.py](https://github.com/ ## OpenAPI (Swagger) Demo -Developing an ACA-Py controller is much like developing a web app that uses a REST API. As you develop, you will want an easy way to test out the behaviour of the API. That's where the industry-standard OpenAPI (aka Swagger) UI comes in. ACA-Py (optionally) exposes an OpenAPI UI in ACA-Py that you can use to learn the ins and outs of the API. This [Aries OpenAPI demo](AriesOpenAPIDemo.md) shows how you can use the OpenAPI UI with an ACA-Py agent by walking through the connecting, issuing a credential, and presenting a proof sequence. +Developing an ACA-Py controller is much like developing a web app that uses a REST API. As you develop, you will want an easy way to test out the behaviour of the API. That's where the industry-standard OpenAPI (aka Swagger) UI comes in. ACA-Py (optionally) exposes an OpenAPI UI in ACA-Py that you can use to learn the ins and outs of the API. This [ACA-Py OpenAPI demo](OpenAPIDemo.md) shows how you can use the OpenAPI UI with an ACA-Py agent by walking through the connecting, issuing a credential, and presenting a proof sequence. ## Performance Demo diff --git a/docs/deploying/ContainerImagesAndGithubActions.md b/docs/deploying/ContainerImagesAndGithubActions.md index 66052223ed..1db5f8ccb7 100644 --- a/docs/deploying/ContainerImagesAndGithubActions.md +++ b/docs/deploying/ContainerImagesAndGithubActions.md @@ -8,7 +8,7 @@ critical to the adoption of not only ACA-Py but also decentralized trust/SSI more generally. Recognizing how critical these images are to the success of ACA-Py and -consistent with Hyperledger's commitment to open collaboration, container images +consistent with the OpenWallet Foundation's commitment to open collaboration, container images are now built and published directly from the Aries Cloud Agent - Python project repository and made available through the [Github Packages Container Registry](https://ghcr.io). @@ -91,7 +91,7 @@ variants and between the BC Gov ACA-Py images. when manually triggered; builds and pushes the Standard ACA-Py variant to the Github Container Registry. - BDD Integration Tests (`.github/workflows/BDDTests.yml`) - Run on pull - requests (to the hyperledger fork only); runs BDD integration tests. + requests (to the openwallet-foundation fork only); runs BDD integration tests. - Format (`.github/workflows/format.yml`) - Run on pull requests; checks formatting of files modified by the PR. - CodeQL (`.github/workflows/codeql.yml`) - Run on pull requests; performs diff --git a/docs/deploying/Databases.md b/docs/deploying/Databases.md index c54deebbb0..af33e710e2 100644 --- a/docs/deploying/Databases.md +++ b/docs/deploying/Databases.md @@ -6,7 +6,7 @@ The wallet supports 2 different databases to store data, SQLite and PostgreSQL. ## SQLite -If the wallet is configured the default way in eg. [demo-args.yaml](https://github.com/hyperledger/aries-cloudagent-python/tree/main/demo/demo-args.yaml), without explicit wallet-storage, a sqlite database file is used. +If the wallet is configured the default way in eg. [demo-args.yaml](https://github.com/openwallet-foundation/acapy/tree/main/demo/demo-args.yaml), without explicit wallet-storage, a sqlite database file is used. ```yaml # demo-args.yaml diff --git a/docs/features/DevReadMe.md b/docs/features/DevReadMe.md index debd55e5b3..ca3a6591c1 100644 --- a/docs/features/DevReadMe.md +++ b/docs/features/DevReadMe.md @@ -1,4 +1,4 @@ -# Developer's Read Me for Hyperledger Aries Cloud Agent - Python +# Developer's Read Me for ACA-Py See the [README](../../README.md) for details about this repository and information about how the Aries Cloud Agent - Python fits into the Aries project and relates to Indy. @@ -59,7 +59,7 @@ variable: For a comprehensive list of all arguments, argument groups, CLI args, and their environment variable equivalents, please see -the [argparse.py](https://github.com/hyperledger/aries-cloudagent-python/blob/main/aries_cloudagent/config/argparse.py) +the [argparse.py](https://github.com/openwallet-foundation/acapy/blob/main/aries_cloudagent/config/argparse.py) file. @@ -126,7 +126,7 @@ aca-py start --inbound-transport http 0.0.0.0 8000 \ --outbound-transport http ``` -ACA-Py ships with both inbound and outbound transport drivers for `http` and `ws` (websockets). Additional transport drivers can be added as pluggable implementations. See the existing implementations in the [transports module](https://github.com/hyperledger/aries-cloudagent-python/tree/main/aries_cloudagent/transport) for getting started on adding a new transport. +ACA-Py ships with both inbound and outbound transport drivers for `http` and `ws` (websockets). Additional transport drivers can be added as pluggable implementations. See the existing implementations in the [transports module](https://github.com/openwallet-foundation/acapy/tree/main/aries_cloudagent/transport) for getting started on adding a new transport. Most configuration parameters are provided to the agent at startup. Refer to the `Running` sections above for details on listing the available command line parameters. @@ -258,7 +258,7 @@ Please also refer to the [contributing guidelines](../../CONTRIBUTING.md) and [c ## Publishing Releases -The [publishing](https://github.com/hyperledger/aries-cloudagent-python/blob/main/PUBLISHING.md) document provides information on tagging a release and publishing the release artifacts to PyPi. +The [publishing](../../PUBLISHING.md) document provides information on tagging a release and publishing the release artifacts to PyPi. ## Dynamic Injection of Services diff --git a/docs/features/JsonLdCredentials.md b/docs/features/JsonLdCredentials.md index b88e6203e8..ec062034d9 100644 --- a/docs/features/JsonLdCredentials.md +++ b/docs/features/JsonLdCredentials.md @@ -1,6 +1,6 @@ # JSON-LD Credentials in ACA-Py -By design Hyperledger Aries is credential format agnostic. This means you can use it for any credential format, as long as an RFC is defined for the specific credential format. ACA-Py currently supports two types of credentials, Indy and JSON-LD credentials. This document describes how to use the latter by making use of [W3C Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) using [Linked Data Proofs](https://w3c-ccg.github.io/ld-proofs). +By design ACA-Py is credential format agnostic. This means you can use it for any credential format, as long as an RFC is defined for the specific credential format. ACA-Py currently supports two types of credentials, AnonCreds and JSON-LD credentials. This document describes how to use the latter by making use of [W3C Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) using [Linked Data Proofs](https://w3c-ccg.github.io/ld-proofs). ## Table of Contents @@ -212,7 +212,7 @@ Call the `/credentials/w3c` endpoint to retrieve all JSON-LD credentials in your ## Present Proof -> ⚠️ TODO: [https://github.com/openwallet-foundation/acapy/pull/1125](https://github.com/hyperledger/aries-cloudagent-python/pull/1125) +> ⚠️ TODO: [https://github.com/openwallet-foundation/acapy/pull/1125](https://github.com/openwallet-foundation/acapy/pull/1125) ## VC-API @@ -228,7 +228,7 @@ These endpoints include: - `POST /vc/presentations/prove` -> proves a presentation - `POST /vc/presentations/verify` -> verifies a presentation -To learn more about using these endpoints, please refer to the available [postman collection](../demo/AriesPostmanDemo.md#experimenting-with-the-vc-api-endpoints). +To learn more about using these endpoints, please refer to the available [postman collection](../demo/PostmanDemo.md#experimenting-with-the-vc-api-endpoints). ## External Suite Provider diff --git a/docs/features/Multitenancy.md b/docs/features/Multitenancy.md index 135f55656b..fb35bbeff3 100644 --- a/docs/features/Multitenancy.md +++ b/docs/features/Multitenancy.md @@ -9,11 +9,7 @@ This allows ACA-Py to be used for a wider range of use cases. One use case could - [General Concept](#general-concept) - [Base and Sub Wallets](#base-and-sub-wallets) - [Usage](#usage) -- [Multi-tenant Admin API](#multi-tenant-admin-api) -- [Managed vs Unmanaged Mode](#managed-vs-unmanaged-mode) - - [Managed Mode](#managed-mode) - - [Unmanaged Mode](#unmanaged-mode) - - [Mode Usage](#mode-usage) + - [Single Wallet vs Multiple Wallets](#single-wallet-vs-multiple-wallets) - [Message Routing](#message-routing) - [Relaying](#relaying) - [Mediation](#mediation) @@ -108,7 +104,7 @@ The mode used can be specified when creating a wallet using the `key_management_ ## Message Routing -In multi-tenant mode, when ACA-Py receives a message from another agent, it will need to determine which tenant to route the message to. Hyperledger Aries defines two types of routing methods, mediation and relaying. +In multi-tenant mode, when ACA-Py receives a message from another agent, it will need to determine which tenant to route the message to. ACA-Py defines two types of routing methods, mediation and relaying. See the [Mediators and Relays](https://github.com/hyperledger/aries-rfcs/blob/master/concepts/0046-mediators-and-relays/README.md) RFC for an in-depth description of the difference between the two concepts. @@ -385,7 +381,7 @@ curl -X POST "${ACAPY_ADMIN_URL}/multitenancy/wallet/{wallet_id}/remove" \ ### Per tenant settings -To allow the configuring of ACA-Py startup parameters/environment variables at a tenant/subwallet level. [PR#2233](https://github.com/hyperledger/aries-cloudagent-python/pull/2233) will provide the ability to update the following subset of settings when creating or updating the subwallet: +To allow the configuring of ACA-Py startup parameters/environment variables at a tenant/subwallet level. [PR#2233](https://github.com/openwallet-foundation/acapy/pull/2233) will provide the ability to update the following subset of settings when creating or updating the subwallet: | Labels | | Setting | |---|---|---| diff --git a/docs/features/SupportedRFCs.md b/docs/features/SupportedRFCs.md index bb717f9b67..cad76194e5 100644 --- a/docs/features/SupportedRFCs.md +++ b/docs/features/SupportedRFCs.md @@ -32,7 +32,7 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b | ---------- | :----------------: | -------------------------------------------------------------------------------------------------------------------------- | | Server | :white_check_mark: | | | Kubernetes | :white_check_mark: | BC Gov has extensive experience running ACA-Py on Red Hat's OpenShift Kubernetes Distribution. | -| Docker | :white_check_mark: | Official docker images are published to the GitHub container repository at `ghcr.io/hyperledger/aries-cloudagent-python`. | +| Docker | :white_check_mark: | Official docker images are published to the GitHub container repository at [https://ghcr.io/openwallet-foundation/acapy](https://ghcr.io/openwallet-foundation/acapy). | | Desktop | :warning: | Could be run as a local service on the computer | | iOS | :x: | | | Android | :x: | | diff --git a/docs/gettingStarted/RoutingEncryption.md b/docs/gettingStarted/RoutingEncryption.md index 93b8207668..94bfcfc159 100644 --- a/docs/gettingStarted/RoutingEncryption.md +++ b/docs/gettingStarted/RoutingEncryption.md @@ -32,6 +32,6 @@ Link: [Mediators and Relays](https://github.com/hyperledger/aries-rfcs/tree/mast ## Message Encryption -The DIDComm encryption handling is handling within the Aries agent, and not really something a developer building applications using an agent needs to worry about. Further, within an Aries agent, the handling of the encryption is left to libraries to handle - ultimately calling dependencies from Hyperledger Ursa. To encrypt a message, the agent code calls a `pack()` function to handle the encryption, and to decrypt a message, the agent code calls a corresponding `unpack()` function. The "wire messages" (as originally called) are described in [detail here](https://github.com/hyperledger/aries-rfcs/blob/master/features/0019-encryption-envelope/README.md), including variations for sender authenticated and anonymous encrypting. Wire messages were meant to indicate the handling of a message from one agent directly to another, versus the higher level concept of routing a message from an edge agent to a peer edge agent. +The DIDComm encryption handling is handling within the ACA-Py agent, and not really something a developer building applications using an agent needs to worry about. Further, within an ACA-Py agent, the handling of the encryption is left to various cryptographic libraries to handle. To encrypt a message, the agent code calls a `pack()` function to handle the encryption, and to decrypt a message, the agent code calls a corresponding `unpack()` function. The "wire messages" (as originally called) are described in [detail here](https://github.com/hyperledger/aries-rfcs/blob/master/features/0019-encryption-envelope/README.md), including variations for sender authenticated and anonymous encrypting. Wire messages were meant to indicate the handling of a message from one agent directly to another, versus the higher level concept of routing a message from an edge agent to a peer edge agent. Much thought has also gone into repudiable and non-repudiable messaging, as [described here](https://github.com/hyperledger/aries-rfcs/tree/master/concepts/0049-repudiation). diff --git a/docs/testing/AgentTracing.md b/docs/testing/AgentTracing.md index ec63dd08d0..2c99e53eee 100644 --- a/docs/testing/AgentTracing.md +++ b/docs/testing/AgentTracing.md @@ -85,7 +85,7 @@ When `Exchange Tracing` is `ON`, all exchanges will include tracing. ## Logging Trace Events to an ELK Stack -You can use the `ELK` stack in the [ELK Stack sub-directory](https://github.com/hyperledger/aries-cloudagent-python/blob/main/demo/elk-stack) as a target for trace events, just start the ELK stack using the docker-compose file and then in two separate bash shells, startup the demo as follows: +You can use the `ELK` stack in the [ELK Stack sub-directory](https://github.com/openwallet-foundation/acapy/blob/main/demo/elk-stack) as a target for trace events, just start the ELK stack using the docker-compose file and then in two separate bash shells, startup the demo as follows: ```bash DOCKER_NET=elknet TRACE_TARGET_URL=logstash:9700 ./run_demo faber --trace-http diff --git a/docs/testing/Logging.md b/docs/testing/Logging.md index 7d2af44e85..b0104d4dd3 100644 --- a/docs/testing/Logging.md +++ b/docs/testing/Logging.md @@ -92,7 +92,7 @@ args=('acapy.log', 'd', 7, 1,) format=%(asctime)s %(wallet_id)s %(levelname)s %(pathname)s:%(lineno)d %(message)s ``` -For `DictConfig` (`dict` logging config file), find an example in [default_per_tenant_logging_config.yml](https://github.com/hyperledger/aries-cloudagent-python/tree/main/aries_cloudagent/config/default_per_tenant_logging_config.yml) with same attributes as `default_per_tenant_logging_config.ini` file. +For `DictConfig` (`dict` logging config file), find an example in [default_per_tenant_logging_config.yml](https://github.com/openwallet-foundation/acapy/tree/main/aries_cloudagent/config/default_per_tenant_logging_config.yml) with same attributes as `default_per_tenant_logging_config.ini` file. ```yaml version: 1 diff --git a/mkdocs.yml b/mkdocs.yml index a909ee22ad..0f8593cb94 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -103,14 +103,14 @@ nav: - Code Generation with the Open API: features/UsingOpenAPI.md - ACA-Py as a DIDComm Mediator: features/Mediation.md - Demos: - - Hyperledger Aries / AnonCreds Workshop: demo/Aries-Workshop.md + - ACA-Py / AnonCreds Workshop: demo/ACA-Py-Workshop.md - The Alice-Faber Demo: demo/README.md - - Open API Tutorial: demo/AriesOpenAPIDemo.md + - Open API Tutorial: demo/OpenAPIDemo.md - Alice Gets a Phone: demo/AliceGetsAPhone.md - Hyperledger Indy Endorser In Action: demo/Endorser.md - Using W3C JSON-LD Credentials: demo/AliceWantsAJsonCredential.md - DIY -- ACME Controller Workshop: demo/AcmeDemoWorkshop.md - - ACA-Py Using Postman Demo: demo/AriesPostmanDemo.md + - ACA-Py Using Postman Demo: demo/PostmanDemo.md - Reusing a Connection Between Agents: demo/ReusingAConnection.md - Getting Started: - Becoming an ACA-Py Developer: gettingStarted/README.md @@ -152,7 +152,7 @@ nav: - Contributing: - How to Contribute: CONTRIBUTING.md - Maintainers: MAINTAINERS.md - - Hyperledger Code of Conduct: CODE_OF_CONDUCT.md + - Code of Conduct: CODE_OF_CONDUCT.md - Security Vulnerability Reporting: SECURITY.md - Publishing an ACA-Py Release: PUBLISHING.md - Managing the ACA-Py Documentation Site: Managing-ACA-Py-Doc-Site.md