Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ake-persson/peekaboo
Micro-service for exposing system and hardware information
https://github.com/ake-persson/peekaboo
go grpc hardware info msa system
Last synced: about 1 month ago
JSON representation
Micro-service for exposing system and hardware information
- Host: GitHub
- URL: https://github.com/ake-persson/peekaboo
- Owner: ake-persson
- License: apache-2.0
- Created: 2020-03-09T05:12:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T21:07:30.000Z (over 1 year ago)
- Last Synced: 2024-10-04T13:34:18.743Z (about 2 months ago)
- Topics: go, grpc, hardware, info, msa, system
- Language: Go
- Homepage:
- Size: 277 KB
- Stars: 4
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://raw.githubusercontent.com/pekaboo-io/peekaboo/master/LICENSE)
# Peekaboo
Micro-service for exposing system and hardware information.
This is a re-factoring of the original [Peekaboo](https://github.com/imc-trading/peekaboo) to support gRPC and MTLS.
## Usage
```
Usage: ./client [options]
-ca-file string
CA certificate file, required for Mutual TLS (default "~/certs/root_ca.crt")
-cert-file string
Server TLS certificate file (default "~/certs/srv.crt")
-colors string
Comma separated list of output colors [black,red,green,yellow,blue,magenta,cyan,light-gray,
dark-gray,light-red,light-green,light-yellow,light-blue,light-magenta,light-cyan,white]
hostname header,hostname content,headers,content (default "light-cyan,light-yellow,cyan,yellow")
-fields string
Comma separated list of fields to output
-fmt string
Output format [json,csv,table,vtable] (default "json")
-key-file string
Server TLS key file (default "~/certs/srv.key")
-mtls
Use Mutual TLS, client and server certificate needs to be signed by the same CA authority to establish trust ...TBD...
-no-color
No color output
-no-tls
No TLS (testing)
-version
Version
resource
Resource to query [system,users,groups,filesystems]
address
Address to agent specified as
(default port 17711)
```
## Install Go
First install Go and then configure Go environment.
### Mac OS X
```bash
brew install go
```
### RedHat/CentOS/Fedora
```bash
yum install golang
```
### Ubuntu/Debian
```
apt-get install goland
```
### Setup Go environment
```bash
mkdir -p ~/go/{src,bin}
cat << EOF >>~/.bash_profile
export GOPATH=~/go
export PATH=\$PATH:\$GOPATH/bin
EOF
source ~/.bash_profile
```
## Clone code
```bash
mkdir -p $GOPATH/src/github.com/peekaboo-labs
cd $GOPATH/src/github.com/peekaboo-labs
git clone https://github.com/peekaboo-labs/peekaboo.git
```
## Build and run
Build and start agent.
```
cd $GOPATH/src/github.com/peekaboo-labs/peekaboo
make deps build
./agent/agent -no-tls
```
Query agent.
```bash
./client/client -no-tls -fmt vtable system localhost
```