README
¶
Console
Disclaimer: Production viable releases are tagged and listed under 'Releases'. Console is under development. The current available tags for download are Alpha version code and should not be used in production. For these Alpha tags, certain features may not function yet, visual look and feel may change, or bugs/errors may occur. Follow along our Feature Backlog for future releases and feature updates.
Overview
Console is an application that provides a 1:1, direct connection for AMT devices for use in an enterprise environment. Users can add activated AMT devices to access device information and device management functionality such as power control, remote keyboard-video-mouse (KVM) control, and more.
Quick start
For Users
-
Find the latest release of Console under Github Releases.
-
Download the appropriate binary assets for your OS and Architecture under the Assets dropdown section.
-
Run Console.
For Developers
Local development (in Linux or WSL):
To start the service with Postgres:
# Postgres
$ make compose-up
# Run app with migrations
$ make run
Download and check out the sample-web-ui:
git clone https://github.com/open-amt-cloud-toolkit/sample-web-ui
Ensure that the environment file has cloud set to false and that the URLs for RPS and MPS are pointing to where you have Console running. The default is http://localhost:8181. Follow the instructions for launching and running the UI in the sample-web-ui readme.
Dev tips for passing CI Checks
- Install gofumpt
go install mvdan.cc/gofumpt@latest(replaces gofmt) - Install gci
go install github.com/daixiang0/gci@latest(organizes imports) - Ensure code is formatted correctly with
gofumpt -l -w -extra ./ - Ensure all unit tests pass with
go test ./... - Ensure code has been linted with
docker run --rm -v ${pwd}:/app -w /app golangci/golangci-lint:latest golangci-lint run -v
Additional Resources
- For detailed documentation and Getting Started, visit the docs site.
-
Find a bug? Or have ideas for new features? Open a new Issue.
-
Need additional support or want to get the latest news and events about Open AMT? Connect with the team directly through Discord.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
|
internal
|
|
|
app
Package app configures and runs application.
|
Package app configures and runs application. |
|
controller/http
Package v1 implements routing paths.
|
Package v1 implements routing paths. |
|
pkg
|
|
|
httpserver
Package httpserver implements HTTP server.
|
Package httpserver implements HTTP server. |