Skip to content

Commit

Permalink
README.md: Add more detailed usage and building instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Vinicius Aquino <vinicius.aquino@ossystems.com.br>
  • Loading branch information
Ossanes authored and otavio committed Mar 11, 2022
1 parent eef8266 commit 0ac798a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ See the comparison table below to help you to choose which version fits you need

## Usage

The easyest way to run a Updatehub CE server is to run a Docker image to start a ready-to-use server.

```
$ docker run updatehub/updatehub-ce --help
Usage:
Expand All @@ -55,8 +57,19 @@ docker run -d -p 8080:8080 updatehub/updatehub-ce:latest
```

On the example above, a Docker image will be automatically downloaded and run on 8080 port.
Now you can access the UpdateHub CE dashboard through the host IP on your web browser.

```
http://<Host_IP_Address>:8080/
```

The default login and password is `admin`.

## Building

If you want to build `updatehub-ce` by yourself, follow these steps:

The `updatehub-ce` uses `go mod` to manage its dependencies and
`yarn` to build the web UI for the server. `go mod` should be
included in your default instalation of the `go` toolchain.
Expand Down

0 comments on commit 0ac798a

Please sign in to comment.