// Copyright 2017 The go-ethereum Authors // This file is part of go-ethereum. // // go-ethereum is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // go-ethereum is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with go-ethereum. If not, see . package main import ( "bytes" "fmt" "html/template" "math/rand" "path/filepath" "strconv" "strings" "github.com/ethereum/go-ethereum/log" ) // explorerDockerfile is the Dockerfile required to run a block explorer. var explorerDockerfile = ` FROM puppeth/blockscout:latest ADD genesis.json /genesis.json RUN \ echo 'geth --cache 512 init /genesis.json' > explorer.sh && \ echo $'exec geth --networkid {{.NetworkID}} --syncmode "full" --gcmode "archive" --port {{.NodePort}} --bootnodes {{.Bootnodes}} --ethstats \'{{.Ethstats}}\' --cache=512 --rpc --rpcapi "net,web3,eth,shh,debug" --rpccorsdomain "*" --rpcvhosts "*" --ws --wsorigins "*" --exitwhensynced' >> explorer.sh && \ echo $'exec geth --networkid {{.NetworkID}} --syncmode "full" --gcmode "archive" --port {{.NodePort}} --bootnodes {{.Bootnodes}} --ethstats \'{{.Ethstats}}\' --cache=512 --rpc --rpcapi "net,web3,eth,shh,debug" --rpccorsdomain "*" --rpcvhosts "*" --ws --wsorigins "*" &' >> explorer.sh && \ echo '/usr/local/bin/docker-entrypoint.sh postgres &' >> explorer.sh && \ echo 'sleep 5' >> explorer.sh && \ echo 'mix do ecto.drop --force, ecto.create, ecto.migrate' >> explorer.sh && \ echo 'mix phx.server' >> explorer.sh ENTRYPOINT ["/bin/sh", "explorer.sh"] ` // explorerComposefile is the docker-compose.yml file required to deploy and // maintain a block explorer. var explorerComposefile = ` version: '2' services: explorer: build: . image: {{.Network}}/explorer container_name: {{.Network}}_explorer_1 ports: - "{{.NodePort}}:{{.NodePort}}" - "{{.NodePort}}:{{.NodePort}}/udp"{{if not .VHost}} - "{{.WebPort}}:4000"{{end}} environment: - NETWORK={{.NetworkName}}{{if .VHost}} - VIRTUAL_HOST={{.VHost}} - VIRTUAL_PORT=4000{{end}} - NODE_PORT={{.NodePort}}/tcp - STATS={{.Ethstats}} - BLOCK_TRANSFORMER={{.Transformer}} volumes: - {{.Datadir}}:/root/.ethereum - {{.DBDir}}:/var/lib/postgresql/data logging: driver: "json-file" options: max-size: "1m" max-file: "10" restart: always ` // deployExplorer deploys a new block explorer container to a remote machine via // SSH, docker and docker-compose. If an instance with the specified network name // already exists there, it will be overwritten! func deployExplorer(client *sshClient, network string, bootnodes []string, config *explorerInfos, nocache bool, isClique bool) ([]byte, error) { // Generate the content to upload to the server workdir := fmt.Sprintf("%d", rand.Int63()) files := make(map[string][]byte) dockerfile := new(bytes.Buffer) template.Must(template.New("").Parse(explorerDockerfile)).Execute(dockerfile, map[string]interface{}{ "NetworkID": config.networkId, "Bootnodes": strings.Join(bootnodes, ","), "Ethstats": config.ethstats, "NodePort": config.nodePort, }) files[filepath.Join(workdir, "Dockerfile")] = dockerfile.Bytes() transformer := "base" if isClique { transformer = "clique" } composefile := new(bytes.Buffer) template.Must(template.New("").Parse(explorerComposefile)).Execute(composefile, map[string]interface{}{ "NetworkName": network, "VHost": config.webHost, "Ethstats": config.ethstats, "Datadir": config.datadir, "DBDir": config.dbdir, "Network": network, "NodePort": config.nodePort, "WebPort": config.webPort, "Transformer": transformer, }) files[filepath.Join(workdir, "docker-compose.yaml")] = composefile.Bytes() files[filepath.Join(workdir, "genesis.json")] = config.genesis // Upload the deployment files to the remote server (and clean up afterwards) if out, err := client.Upload(files); err != nil { return out, err } defer client.Run("rm -rf " + workdir) // Build and deploy the boot or seal node service if nocache { return nil, client.Stream(fmt.Sprintf("cd %s && docker-compose -p %s build --pull --no-cache && docker-compose -p %s up -d --force-recreate --timeout 60", workdir, network, network)) } return nil, client.Stream(fmt.Sprintf("cd %s && docker-compose -p %s up -d --build --force-recreate --timeout 60", workdir, network)) } // explorerInfos is returned from a block explorer status check to allow reporting // various configuration parameters. type explorerInfos struct { genesis []byte datadir string dbdir string ethstats string nodePort int webHost string webPort int networkId int64 } // Report converts the typed struct into a plain string->string map, containing // most - but not all - fields for reporting to the user. func (info *explorerInfos) Report() map[string]string { report := map[string]string{ "Data directory": info.datadir, "Node listener port ": strconv.Itoa(info.nodePort), "Ethstats username": info.ethstats, "Website address ": info.webHost, "Website listener port ": strconv.Itoa(info.webPort), } return report } // checkExplorer does a health-check against a block explorer server to verify // whether it's running, and if yes, whether it's responsive. func checkExplorer(client *sshClient, network string) (*explorerInfos, error) { // Inspect a possible explorer container on the host infos, err := inspectContainer(client, fmt.Sprintf("%s_explorer_1", network)) if err != nil { return nil, err } if !infos.running { return nil, ErrServiceOffline } // Resolve the port from the host, or the reverse proxy webPort := infos.portmap["4000/tcp"] if webPort == 0 { if proxy, _ := checkNginx(client, network); proxy != nil { webPort = proxy.port } } if webPort == 0 { return nil, ErrNotExposed } // Resolve the host from the reverse-proxy and the config values host := infos.envvars["VIRTUAL_HOST"] if host == "" { host = client.server } // Run a sanity check to see if the devp2p is reachable nodePort := infos.portmap[infos.envvars["NODE_PORT"]] if err = checkPort(client.server, nodePort); err != nil { log.Warn(fmt.Sprintf("Explorer devp2p port seems unreachable"), "server", client.server, "port", nodePort, "err", err) } // Assemble and return the useful infos stats := &explorerInfos{ dbdir: infos.volumes["/var/lib/postgresql/data"], datadir: infos.volumes["/root/.ethereum"], nodePort: nodePort, webHost: host, webPort: webPort, ethstats: infos.envvars["STATS"], } return stats, nil }