Skip to content

Feat: remove .env section from non-manual deployment #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 23, 2025
Merged

Feat: remove .env section from non-manual deployment #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 11 additions & 25 deletions docs/guides/running-surge/deploy-l2.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,29 +27,8 @@ git clone https://github.com/NethermindEth/simple-surge-node.git
cd simple-surge-node
```

### 2. Configure Environment

The deployment script will automatically handle environment configuration. For Devnet deployments, if no `.env` file exists, the script will automatically copy `.env.devnet` to `.env`.

For Staging or Testnet environments, you'll need to manually copy the appropriate environment file:

```bash
# For Staging
cp .env.staging .env

# For Testnet
cp .env.testnet .env
```

:::tip Environment Configuration
The environment files include default values for each configuration (devnet, staging, testnet), based on previously generated data. You can customize these values, such as L1 and L2 settings, genesis hashes, and addresses, as needed.
:::

:::note
`host.docker.internal` values in the `.env` file might not work in all environments. If you encounter issues, replace `host.docker.internal` with your server's IP address or hostname.
:::

### 3. Start Protocol Deployment Script
### 2. Start Protocol Deployment Script

[Simple Surge Node](https://github.com/NethermindEth/simple-surge-node) automates the deployment of L2 and Surge protocol components using a convenient script.
Run the deployment script with:
Expand Down Expand Up @@ -101,6 +80,13 @@ You'll be prompted to confirm the deployment parameters. Here are the main promp
For Staging and Testnet environments, the protocol contracts are already deployed. The script will exit and instruct you to copy the appropriate `.env` file and run `surge-stack-deployer.sh` directly.
:::

:::tip Environment Configuration
After you choose the environment, the script will create a corresponding `.env` file in the root directory.
The environment file includes default values for configuration.
You can customize these values, such as L1 and L2 settings, genesis hashes, and addresses, as needed, but typically no changes are required for standard deployments.
:::


#### Remote or Local

Choose `local` if you are deploying everything on a single machine. Choose `remote` if you are deploying across multiple machines or connecting to remote devnet instances.
Expand Down Expand Up @@ -142,7 +128,7 @@ If you have already deployed the protocol contracts, the script will ask you:
Here you can redeploy the protocol or just use the existing deployment.
:::

### 4. Prover Deployment
### 3. Prover Deployment

In Surge, provers are required to be registered in the protocol before they can start proving tasks.
The script will ask whether provers are running and ready for registration:
Expand Down Expand Up @@ -172,7 +158,7 @@ You can type `false` and skip this step if you don't want to run provers.
Otherwise, if you want to run provers, follow the instructions in the
[Provers Setup Guide](provers/index.mdx) to deploy and register your provers before continuing.

### 5. Depositing Bond
### 4. Depositing Bond

The script will ask you whether you want to deposit the proving liveness bond for your provers:

Expand All @@ -189,7 +175,7 @@ The script will ask you whether you want to deposit the proving liveness bond fo
It's recommended to deposit the bond to ensure your provers remain active and available for proving tasks.
The default bond amount is 1000 ETH (converted to wei automatically).

### 6. Next Steps
### 5. Next Steps

After completing the protocol deployment, you can proceed to deploy Surge stack components using:

Expand Down
22 changes: 14 additions & 8 deletions docs/guides/surge-on-hoodi/run-l2.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,18 @@ git clone https://github.com/NethermindEth/simple-surge-node.git
cd simple-surge-node
```

### 2. Configure Environment

### 2. Start Components

You have two options to start the L2 components:

<Tabs>
<TabItem value="docker" label="Option A: Docker Compose (Simpler)" default>


This is the recommended approach for most users. First, you need to configure the `.env` file.

#### 1. Configure Environment

Create your environment configuration file (`.env`) by copying the provided sample:

Expand All @@ -49,14 +60,9 @@ And make sure to update the L1 URLs to match the ones you're using.
`host.docker.internal` values in the `.env` file might not work in all environments. If you encounter issues, replace `host.docker.internal` with your server's IP address or hostname.
:::

### 3. Start Components

You have two options to start the L2 components:

<Tabs>
<TabItem value="docker" label="Option A: Docker Compose (Simpler)" default>
#### 2. Start Docker Compose Components

This is the recommended approach for most users. L2 consists of the following components - launch the ones specific to your needs.
L2 consists of the following components below, launch the ones specific to your needs.

:::tip
You can run multiple profiles at once:
Expand Down