Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ashuaidehao committed Dec 14, 2022
1 parent c6264cb commit 95fc0d2
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# N3-Docker

## File Description
## Quick Start

- **Dockerfile**: Docker build file
- **prepare-node.sh**: Download node and plugins files, update `nodeversion` after NEO release new version node and plugins.
- **start.sh**: Container start script, start node with `screen`
You can use our default deployed images directly, see [n3-docker](https://github.com/neo-ngd/n3-docker/pkgs/container/n3-docker).
The default node contains ApplicationLogs and RpcServer Plugins(see **prepare-node.sh**).

```shell
docker run -dit --name n3-node -p 10332-10334:10332-10334 ghcr.io/neo-ngd/n3-docker:latest
```

## Build example
## Manual Build

You can change the scripts and build your own docker images.

```shell
docker build -t neo-cli .
docker run -dit --name n3-node -p 10332-10334:10332-10334 neo-cli
```
The default node contains ApplicationLogs and RpcServer Plugins(see **prepare-node.sh**).

## Quick Start

You can use our default deployed images directly, see [n3-docker](https://github.com/nep-ngd/N3-Docker/pkgs/container/n3-docker).
## File Description

```shell
docker run -dit --name n3-node -p 10332-10334:10332-10334 ghcr.io/neo-ngd/n3-docker:latest
```
- **Dockerfile**: Docker build file
- **prepare-node.sh**: Download node and plugins files, update `nodeversion` after NEO release new version node and plugins.
- **start.sh**: Container start script, start node with `screen`

0 comments on commit 95fc0d2

Please sign in to comment.