testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console/README.md
Prathamesh Musale 774184c810 Rename laconic2d container and services to laconicd (#8)
Part of [Rename laconic2d to laconicd](https://www.notion.so/Rename-laconic2d-to-laconicd-9028d0c020d24d1288e92ebcb773d7a7)

Co-authored-by: IshaVenikar <ishavenikar7@gmail.com>
Reviewed-on: #8
Co-authored-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
Co-committed-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
2024-07-23 12:55:38 +00:00

3.1 KiB

laconic-console

Instructions for running laconic registry CLI and console

Prerequisites

  • laconicd RPC and GQL endpoints

Setup

  • Clone the stack repo:

    laconic-so fetch-stack git.vdb.to/cerc-io/testnet-laconicd-stack
    
  • Clone required repositories:

    laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console setup-repositories
    
  • Build the container images:

    laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console build-containers
    

    This should create the following docker images locally:

    • cerc/laconic-registry-cli
    • cerc/webapp-base
    • cerc/laconic-console-host

Create a deployment

  • Create a spec file for the deployment:

    laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console deploy init --output laconic-console-spec.yml
    
  • Edit network in the spec file to map container ports to host ports as required:

    ...
    network:
      ports:
        laconic-console:
          - '8080:80'
    
  • Create a deployment from the spec file:

    laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console deploy create --spec-file laconic-console-spec.yml --deployment-dir laconic-console-deployment
    

Configuration

  • Inside the deployment directory, open config.env file and set following env variables:

    # All optional
    
    # CLI configuration
    
    # laconicd RPC endpoint (default: http://laconicd:26657)
    CERC_LACONICD_RPC_ENDPOINT=
    
    # laconicd GQL endpoint (default: http://laconicd:9473/api)
    CERC_LACONICD_GQL_ENDPOINT=
    
    # laconicd chain id (default: laconic_9000-1)
    CERC_LACONICD_CHAIN_ID=
    
    # laconicd user private key for txs
    CERC_LACONICD_USER_KEY=
    
    # laconicd bond id for txs
    CERC_LACONICD_BOND_ID=
    
    # Gas limit for txs (default: 200000)
    CERC_LACONICD_GAS=
    
    # Max fees for txs (default: 200000photon)
    CERC_LACONICD_FEES=
    
    # Console configuration
    
    # Laconicd (hosted) GQL endpoint (default: http://localhost:9473)
    LACONIC_HOSTED_ENDPOINT=
    

Run

  • Start the deployment:

    laconic-so deployment --dir laconic-console-deployment start
    
  • View the laconic console at http://localhost:8080

  • Use the cli service for registry CLI operations:

    # Example
    laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry status"
    

Check status

  • To list down and monitor the running containers:

    # With status
    docker ps -a
    
    # Follow logs for console container
    laconic-so deployment --dir laconic-console-deployment logs console -f
    

Clean up

  • Stop all services running in the background:

    # Stop the docker containers
    laconic-so deployment --dir laconic-console-deployment stop
    
  • To stop all services and also delete data:

    # Stop the docker containers
    laconic-so deployment --dir laconic-console-deployment stop --delete-volumes
    
    # Remove deployment directory (deployment will have to be recreated for a re-run)
    rm -r laconic-console-deployment