https://github.com/archethic-foundation/aeweb-github-action
Github Action to deploy website on Archethic Blockchain
https://github.com/archethic-foundation/aeweb-github-action
archethic github-actions hosting web3
Last synced: 29 days ago
JSON representation
Github Action to deploy website on Archethic Blockchain
- Host: GitHub
- URL: https://github.com/archethic-foundation/aeweb-github-action
- Owner: archethic-foundation
- License: agpl-3.0
- Created: 2022-08-25T09:06:46.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-07T19:22:50.000Z (2 months ago)
- Last Synced: 2025-05-09T23:03:09.572Z (about 1 month ago)
- Topics: archethic, github-actions, hosting, web3
- Language: JavaScript
- Homepage:
- Size: 10.5 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Deploy to AEweb GitHub action
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](https://github.com/archethic-foundation/aeweb-cli) code.
## Usage
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:
```yaml
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/[email protected]
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
sendTransactionTimeout: 60 # seconds
percentageOfConfirmations: 50 # % to consider the transaction successful
```
In 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.
## Keychain's integration
if you want to leverage your decentralized keychain you can use one your service to deploy website.
```yaml
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/[email protected]
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 chain
```
If you want to use the wallet, you have to provide your passphrase composed of 24 words i the Github's secret: _ARCH_BASE_SEED_
## SSL integration
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.
```yaml
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/[email protected]
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.**
## Notes
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.
## Development
To test the development of the Github actions, you can use docker container.
INPUT_SEED is the seed used to publish the website
```sh
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
```