GitHub Action
Archethic Web
This is a very simple GitHub action that allows you to deploy to Archethic decentralised webhosting. The action works by running part of the aeweb-cli code.
To get started using the action, create a folder called .github and inside it, create another folder called workflows. Finally inside the workflows folder, create a file called main.yml with the following contents:
on: [push]
jobs:
deploy_to_aeweb:
runs-on: ubuntu-latest
name: A job to deploy file to AEweb
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Deploy to AEweb
id: deploy
uses: archethic-foundation/aeweb-github-action@v1.8.3
with:
seed: ${{ secrets.ARCH_BASE_SEED }}
endpoint: "https://testnet.archethic.net" #Endpoint you want to deploy to
path: "./web_site_test" #Path to the folder you want to deployIn your Repo, go to Settings -> Secrets and click on "New Secret". Then enter ARCH_BASE_SEED as the seed to your transaction chain.
The seed should never be hardcoded in your code.
Please make sure you have sufficient funds in your chain to deploy your file/folder.
if you want to leverage your decentralized keychain you can use one your service to deploy website.
on: [push]
jobs:
deploy_to_aeweb:
runs-on: ubuntu-latest
name: A job to deploy file to AEweb
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Deploy to AEweb
id: deploy
uses: archethic-foundation/aeweb-github-action@v1.8.0
with:
seed: ${{ secrets.ARCH_BASE_SEED }}
endpoint: "https://testnet.archethic.net" #Endpoint you want to deploy to
path: "./web_site_test" #Path to the folder you want to deploy
keychainFundingService: "archethic-wallet-TEST_AEWEB" # Service to fund the website's chain
keychainWebsiteService: "aeweb-website1" # Service to identify the website's chainIf you want to use the wallet, you have to provide your passphrase composed of 24 words i the Github's secret: ARCH_BASE_SEED
if you wish to deploy your website to HTTPS, we have to include a SSL certificate and SSL private key in the Github Actions secrets and AEWeb will deploy the website securely on the Archethic Blockchain.
on: [push]
jobs:
deploy_to_aeweb:
runs-on: ubuntu-latest
name: A job to deploy file to AEweb
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Deploy to AEweb
id: deploy
uses: archethic-foundation/aeweb-github-action@v1.8.0
with:
seed: ${{ secrets.ARCH_BASE_SEED }}
endpoint: "https://testnet.archethic.net" #Endpoint you want to deploy to
path: "./web_site_test" #Path to the folder you want to deploy
sslCertificateFile: "cert.pem" # Filepath for the certificate file
sslKey: ${{ secrets.SSL_KEY }}In your Repo, go to Settings -> Secrets and click on "New Secret". Then enter SSL_KEY as credentials for your HTTPS website.
The SSL key should never be hardcoded in your code.
Be careful, the action does not yet support max fees limitation. More your website will be big and how many updates you will do, more you will need to fund the website's chain.
SEND_TRANSACTION_TIMEOUT (default=60000) is used to tweak the timeout. PERCENTAGE_OF_CONFIRMATIONS (default=50) is used to tweak the percent of successful confirmations to set a transaction as successful.
To test the development of the Github actions, you can use docker container. INPUT_SEED is the seed used to publish the website
docker build -t aeweb_actions .
docker run -e INPUT_SEED=XXX -e INPUT_ENDPOINT=http://host.docker.internal:4000 -e INPUT_PATH=/tmp/mywebsite -v /tmp/mywebsite:/tmp/mywebsite aeweb_actions