Skip to content

Commit

Permalink
chore: profile current docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Chomtana committed Jan 16, 2024
1 parent 6faf5f3 commit e92eed7
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,39 @@ Open `.env` with your editor of choice
### Start

```sh
docker compose up -d
docker compose --profile current up -d
```

Will start the node in a detatched shell (`-d`), meaning the node will continue to run in the background.

If you want to self-host historical l2geth node, append `--profile legacy` to `--profile current` on every command.

```sh
docker compose --profile current --profile legacy up -d
```

### View logs

```sh
docker compose --profile current logs -f --tail 10
```

To view logs of all containers.

```sh
docker compose --profile current logs <CONTAINER_NAME> -f --tail 10
```

To view logs for a specific container. Most commonly used `<CONTAINER_NAME>` are:
* op-geth
* op-node
* bedrock-init
* l2geth

### Stop

```sh
docker compose down
docker compose --profile current down
```

Will shut down the node without wiping any volumes.
Expand All @@ -125,24 +149,24 @@ You can safely run this command and then restart the node again.
### Restart

```sh
docker compose restart
docker compose --profile current restart
```

Will restart the node safely with minimal downtime but without upgrading the node.

### Upgrade

```sh
docker compose pull
docker compose up --build --force-recreate -d
docker compose --profile current pull
docker compose --profile current up --build --force-recreate -d
```

Will upgrade your node with minimal downtime.

### Wipe [DANGER]

```sh
docker compose down -v
docker compose --profile current down -v
```

Will shut down the node and WIPE ALL DATA. Proceed with caution!
Expand Down

0 comments on commit e92eed7

Please sign in to comment.