Skip to content

Commit 157140c

Browse files
authored
Updated Tag Based Workflow (#295)
* updated tag based workflow to also update when new tag is pushed to docker hub * docs updated
1 parent 41aee74 commit 157140c

File tree

5 files changed

+15
-18
lines changed

5 files changed

+15
-18
lines changed

.github/workflows/tagBasedImageBuild.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,6 @@ jobs:
2828
target: prod
2929
platforms: linux/amd64,linux/arm64
3030
push: true
31-
tags: thirdweb/engine:${{ github.ref_name }} # Set the docker tag to the Git tag name
31+
tags: |
32+
thirdweb/engine:${{ github.ref_name }}
33+
thirdweb/engine:latest

docs/1-user-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Web3-api enables you to create and use backend wallets. To get started create yo
4646

4747
Backend wallets are used by the web3-api to execute transactions, you should think of these as owned by the developer who's running the server.
4848

49-
1.POST /create/wallet
49+
1.POST /backend-wallet/create
5050
`{
5151
"walletType": "aws-kms | gcp-kms | local"
5252
}`

docs/guides/deployment/zeet-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ THIRDWEB_API_SECRET_KEY
2323
- Add a Project Name
2424

2525
11. Click on `Deploy` button
26-
12. Once the deployment is complete, you can click on the URL given by zeet to access the API & Swagger UI
26+
12. Once the deployment is complete, you can click on the URL given by zeet to check if Engine is running.

docs/kms/aws_kms_how_to.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ kms:CreateAlias
1515
kms:Verify
1616
```
1717

18-
3. Create an AWS KMS key, see [here](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) for more details. or, you can use the `/wallet/create` to create a key.
18+
3. Create an AWS KMS key, see [here](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) for more details. or, you can use the `/backend-wallet/create` to create a key.
1919

2020
NOTE:
2121

@@ -27,17 +27,13 @@ Key Spec: ECC_SECG_P256K1
2727
Key Usage: Sign and verify
2828
```
2929

30-
Once you create the key above, you can use `/wallet/add` and send details on the end-point to create the wallet
31-
3230
### Set up Web3-API with AWS KMS
3331

3432
If you are on the `latest` or `nightly` version of Web3-API, then you can use the below steps to set up AWS KMS:
3533

3634
1. Make sure your Engine is running with the environment variables setup, see [here](../1-user-guide.md) for more details.
3735
2. Open `http://localhost:3005` in your browser to see the Swagger UI.
38-
3. Copy the `THIRDWEB_API_SECRET_KEY` and use it in the `Authorization` header. On Swagger UI click on `Authorize` on top-righ corner and paste the `THIRDWEB_API_SECRET_KEY` in the `value` field and click `Authorize`.
39-
4. Open `Configurations Tab`
40-
5. Click on `POST /configuration/wallets` and paste the below body:
36+
3. Open `Configurations Tab` and use the AWS Access Key ID, AWS Access Secret Key & AWS Region to setup AWS KMS.
4137

4238
```js
4339
{
@@ -48,11 +44,11 @@ If you are on the `latest` or `nightly` version of Web3-API, then you can use th
4844
}
4945
```
5046

51-
6. Click `execute` & the AWS KMS Config will be added to Engine.
47+
4. Click `create` & the AWS KMS Config will be added to Engine.
5248

5349
Now you can Create or Import AWS KMS Wallets using the `/backend-wallet/create` or `/backend-wallet/import` endpoints.
5450

55-
For Engine Version below `v0.0.3`, use the below:
51+
#### For Engine Version below `v0.0.3`, use the below:
5652

5753
Create a `.env` file in the root directory of the project and add the below details.
5854

docs/kms/google_kms_how_to.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,18 @@ Cloud KMS CryptoKey Signer/Verifier
1717
5. Click `Add Key` -> Create new Key -> select `JSON` & download the JSON file. This JSON file details will be used to authenticate google auth while using Google Cloud KMS.
1818
6. Create a keyring in Google KMS, see [here](https://cloud.google.com/kms/docs/create-key-ring) for more details.
1919

20-
Optional: Create a key in the keyring, see [here](https://cloud.google.com/kms/docs/create-key) for more details. or, you can use the `/wallet/create` to create a key in the keyring.
20+
Optional: Create a key in the keyring, see [here](https://cloud.google.com/kms/docs/create-key) for more details. or, you can use the `/backend-wallet/create` to create a key in the keyring.
2121

2222
### Set up with Google KMS
2323

2424
If you are on the `latest` or `nightly` version of Web3-API, then you can use the below steps to set up AWS KMS:
2525

2626
1. Make sure your Engine is running with the environment variables setup, see [here](../1-user-guide.md) for more details.
27-
2. Open `http://localhost:3005` in your browser to see the Swagger UI.
28-
3. Copy the `THIRDWEB_API_SECRET_KEY` and use it in the `Authorization` header. On Swagger UI click on `Authorize` on top-righ corner and paste the `THIRDWEB_API_SECRET_KEY` in the `value` field and click `Authorize`.
29-
4. Open `Configurations Tab`
30-
5. Click on `POST /configuration/wallets` and paste the below body:
27+
2. Open [thirdweb Engine Dashboard](https://thirdweb.com/dashboard/engine) and add your local Engine URL `https://localhost:3005`
28+
3. Open `Configurations Tab` and use the details from the JSON file downloaded to setup GCP KMS.
3129

3230
```js
3331
{
34-
"type": "gcp-kms",
3532
"gcpApplicationProjectId": "<your-gcp-application-project-id>",
3633
"gcpKmsLocationId": "<your-gcp-kms-location-id>",
3734
"gcpKmsKeyRingId": "<your-gcp-key-ring-id>",
@@ -40,10 +37,12 @@ If you are on the `latest` or `nightly` version of Web3-API, then you can use th
4037
}
4138
```
4239

43-
6. Click `execute` & the GCP KMS Config will be added to Engine.
40+
4. Click `create` & the GCP KMS Config will be added to Engine.
4441

4542
Now you can Create or Import GCP KMS Wallets using the `/backend-wallet/create` or `/backend-wallet/import` endpoints.
4643

44+
#### For Engine Version below `v0.0.3`, use the below:
45+
4746
Create a `.env` file in the root directory of the project and add the below details.
4847

4948
```

0 commit comments

Comments
 (0)