cerc-io/din-payments-stack
14
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request 'Updates to doc' (#13) from dboreham/update-doc into main
Some checks failed
Test DIN Payments Stack / Run DIN payments stack test (push) Has been cancelled
Details

Browse Source 
Reviewed-on: #13
This commit is contained in:
David Boreham 2024-06-20 17:14:32 +00:00
commit 00443a02e4
1 changed files with 38 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
stack-orchestrator/stacks/din-payments/README.md
View File

@ -4,44 +4,63 @@ Deploy a stack for demoing Nitro-based auth, using either a local fixturenet (fu
## Local Fixturenet (Self-Contained)
### Clone the stack repo
First we define some environment variables to make the commands below more concise:
```
$ export FIXTURENET_STACK=~/cerc/fixturenet-eth-stacks/stack-orchestrator/stacks/fixturenet-eth
$ export DIN_PAYMENTS_STACK=~/cerc/din-payments-stack/stack-orchestrator/stacks/din-payments
```
### Clone the stack repos
```
$ laconic-so fetch-stack git.vdb.to/cerc-io/din-payments-stack
$ laconic-so fetch-stack git.vdb.to/cerc-io/fixturenet-eth-stacks
```
### Clone required repositories
### Clone required repositories (optional)
This and the next step are optional if container images are downloaded from a registry (see Fetch Containers below).
```
$ laconic-so --stack fixturenet-eth setup-repositories
$ laconic-so --stack $FIXTURENET_STACK setup-repositories
$ laconic-so --stack ~/cerc/din-payments-stack/stacks/din-payments setup-repositories
```
### Build containers
### Build containers (optional)
```
$ laconic-so --stack fixturenet-eth build-containers
$ laconic-so --stack ~/cerc/din-payments-stack/stacks/din-payments build-containers
$ laconic-so --stack $FIXTURENET_STACK build-containers
$ laconic-so --stack $DIN_PAYMENTS_STACK build-containers
```
### Create a deployment
### Fetch containers
As an alternative to building containers locally, images can be downloaded from an image registry:
```
$ laconic-so --stack fixturenet-eth deploy init --output nitro-net.yml
$ laconic-so --stack fixturenet-eth deploy create --spec-file nitro-net.yml --deployment-dir /srv/nitro-net
$ laconic-so --stack $FIXTURENET_STACK fetch-containers --image-registry git.vdb.to/cerc-io --registry-username <username> --registry-token <token> --force-local-overwrite
$ laconic-so --stack $DIN_PAYMENTS_STACK fetch-containers --image-registry git.vdb.to/cerc-io --registry-username <username> --registry-token <token> --force-local-overwrite
```
$ laconic-so --stack ~/cerc/din-payments-stack/stacks/din-payments deploy init --map-ports-to-host any-same --output nitro-auth.yml
$ laconic-so --stack ~/cerc/din-payments-stack/stacks/din-payments deploy create --spec-file nitro-auth.yml --deployment-dir /srv/nitro-auth
### Create deployments
```
$ laconic-so --stack $FIXTURENET_STACK deploy init --output nitro-net.yml
$ laconic-so --stack $FIXTURENET_STACK deploy create --spec-file nitro-net.yml --deployment-dir nitro-net
$ laconic-so --stack $DIN_PAYMENTS_STACK deploy init --map-ports-to-host any-same --output nitro-auth.yml
$ laconic-so --stack $DIN_PAYMENTS_STACK deploy create --spec-file nitro-auth.yml --deployment-dir nitro-auth
# Place them both in the same namespace (TODO: support setting the deployment name via --cluster).
$ cp /srv/nitro-net/deployment.yml /srv/nitro-auth/deployment.yml
$ cp nitro-net/deployment.yml nitro-auth/deployment.yml
```
### Start the containers
```
$ laconic-so deployment --dir /srv/nitro-net up
$ laconic-so deployment --dir /srv/nitro-auth up
$ laconic-so deployment --dir nitro-net start
$ laconic-so deployment --dir nitro-auth start
```
### Open the webapp
@ -55,20 +74,20 @@ This example will use the Linea Sepolia testnet.
### Clone required repositories
```
$ laconic-so --stack go-nitro-auth setup-repositories
$ laconic-so --stack $DIN_PAYMENTS_STACK setup-repositories
```
### Build containers
```
$ laconic-so --stack go-nitro-auth build-containers
$ laconic-so --stack $DIN_PAYMENTS_STACK build-containers
```
### Create a deployment
```
$ laconic-so --stack go-nitro-auth deploy init --map-ports-to-host any-same --output nitro-auth.yml
$ laconic-so --stack go-nitro-auth deploy create --spec-file nitro-auth.yml --deployment-dir /srv/nitro-auth
$ laconic-so --stack $DIN_PAYMENTS_STACK deploy init --map-ports-to-host any-same --output nitro-auth.yml
$ laconic-so --stack $DIN_PAYMENTS_STACK deploy create --spec-file nitro-auth.yml --deployment-dir nitro-auth
```
### Set your keys, contract addresses, etc.
@ -102,7 +121,7 @@ CERC_NITRO_CHAIN_PK_BOB=<BOB_PRIVATE_KEY_HERE>
### Start the stack
```
$ laconic-so deployment --dir /srv/nitro-auth up
$ laconic-so deployment --dir nitro-auth start
```
### Open the webapp