Skip to content

Commit

Permalink
Merge pull request #2 from spheronFdn/updates
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
Giri-Spheron authored Nov 3, 2023
2 parents c0ae30d + 0de7625 commit 1f62198
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,26 @@ Follow these steps to set up the Spheron site deployer Service on a local server

```
# 🔑 Ethereum Private Key for signing transactions and data
# this is an example private key and wont work
PRIVATE_KEY=6e32d4762c68cd4c565918abe5fb23108fe2a6875f60c97fd954701b5fba8254
PRIVATE_KEY=12e4..........
# 📡 Channel Address for listening to notifications
LISTEN_TO_CHANNEL=0xFdBA275E47e3B56A5B5b0dC6765CAdB2D178e21e
LISTEN_TO_CHANNEL=0xFd..........
# 🔧 Spheron Access Token for authentication and access to Spheron services
# this is an example access token and wont work
SPHERON_ACESS_TOKEN=zadsaJhbGciOiJIUzI1NiIs
SPHERON_ACESS_TOKEN=zads..........
# 🌐 GitHub URL for the project repository
# this is an example link and wont work
PROJECT_GITHUB_URL=https://github.com/Giri-Spheron/demo-test
PROJECT_GITHUB_URL=
# 📛 Name of the project
PROJECT_NAME=Testing-demo
PROJECT_NAME=Spheron-Site-Deployer
# 🌐 Custom Environment Variables for the Web Application
ENV_VAR1=123456789
ENV_VAR2=123456789
ENV_VAR3=123456789
ENV_VAR1=abcd.........
ENV_VAR2=1234..........
ENV_VAR3=aplha..........
```

Expand All @@ -54,6 +52,7 @@ ENV_VAR3=123456789
7. Add domain configurations post-deployment, or automate it using the SDK. Reference: [Spheron domain documentation](https://docs.spheron.network/static/projects/domain/).
8. `node main.js`

yayyy! 🚀
You're now running a local server that listens for Push protocol notifications to trigger web app deployments on decentralized storage via Spheron.

### Why you need to run a local server here?
Expand All @@ -64,7 +63,7 @@ Running a local server for the Spheron site deployer service is crucial for two

2. **Decentralization**: In line with Web3 ethos, maintaining your keys locally promotes a decentralized architecture, avoiding reliance on centralized cloud services. This enhances trustlessness and resilience in your operational model.

### How it works
### How it works ?

The service leverages local environmental configurations to initialize blockchain interaction tools securely. It uses PushAPI to listen for specific on-chain events and triggers a Spheron-based deployment of your web applications to IPFS when those events occur. The deployment leverages only relevant environmental variables, ensuring efficient and secure automation within the local infrastructure.

Expand Down

0 comments on commit 1f62198

Please sign in to comment.