fix(README): supported backends, sensors and distribution specific repos
This commit is contained in:
parent
cc317e0b6c
commit
17dda6a987
GPG Key ID:
852BCC170D81A982
82
README.md
82
README.md
|
|
@ -8,56 +8,56 @@
|
|||
|
||||
Flucky is a lightweight program written in go for reading data from sensors, for
|
||||
example with a banana or raspberry pi. In addition, flucky provides a REST-API
|
||||
to receive from other flucky installations measured values. The measured values
|
||||
can be saved in a logfile or into a database. Currently is only postgres
|
||||
supported.
|
||||
to receive from other flucky installations measured values. All received
|
||||
measured values, no matter if they come directly from flucky or from a server
|
||||
instance of flucky with the provided REST-API, can be stored into a database.
|
||||
|
||||
## Supported and planned sensors
|
||||
|
||||
| Name | Measured values | Supported |
|
||||
| ------- | --------------------------------------- | --------- |
|
||||
| BME280 | humidity, pressure, temperature | Yes |
|
||||
| DHT11 | temperature | Yes |
|
||||
| DHT22 | temperature | Yes |
|
||||
| DS18B20 | temperature | Yes |
|
||||
| SDS011 | fine dust | Planning |
|
||||
|
||||
## Supported and planned backends
|
||||
|
||||
| Backend | Supported |
|
||||
| --------------- | --------------- |
|
||||
| flucky | WIP |
|
||||
| Logfile | CSV, JSON, XML |
|
||||
| MySQL, MariaDB | Planning |
|
||||
| PostgreSQL | Yes |
|
||||
| SQLite | Planning |
|
||||
|
||||
## Installation
|
||||
|
||||
Flucky can be installed over multiple ways, for example with your local package
|
||||
manager from your linux distribution. At the moment it's only the rpm package
|
||||
format supported. Alternatively the source code can be compiled to get the
|
||||
flucky binary.
|
||||
Flucky can be installed over multiple ways. For example over a specific linux
|
||||
distributions package or as container. The following table lists all
|
||||
repositories where flucky can be otained from, but flucky can already be
|
||||
compiled from source code.
|
||||
|
||||
### RPM-Package
|
||||
|
||||
To install flucky over a RPM package you can download a specific version from
|
||||
github.com or configure the RPM-Mirror.
|
||||
|
||||
#### RPM-Mirror
|
||||
|
||||
```bash
|
||||
$ cat > /etc/yum.repos.d/flucky.rpm <<EOF
|
||||
[flucky]
|
||||
name=flucky
|
||||
baseurl=http://rpm-mirror.cryptic.systems
|
||||
gpgcheck=0
|
||||
EOF
|
||||
$ yum update && yum install --assumeyes flucky
|
||||
```
|
||||
|
||||
#### Download github.com
|
||||
|
||||
```bash
|
||||
$ VERSION=v0.1.0 \
|
||||
ARCH=amd64 \
|
||||
curl --location https://github.com/volker-raschek/flucky/releases/download/${VERSION}/linux-${ARCH}-flucky.rpm -O flucky-${VERSION}-${ARCH}.rpm
|
||||
$ yum install --assumeyes flucky-${VERSION}-${ARCH}.rpm
|
||||
```
|
||||
| Distribution | Repo's |
|
||||
| --------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| Arch Linux | [armv7](https://arch.cryptic.systems/armv7), [x86_64](https://arch.cryptic.systems/x86_64) |
|
||||
| Debian, Ubuntu, Linux Mint | Currently not supported |
|
||||
| RHEL, Fedora, Centos | Planning |
|
||||
| Container Image | [hub.docker.com](https://hub.docker.com/repository/docker/volkerraschek/flucky) |
|
||||
|
||||
### Compiling the source code
|
||||
|
||||
An additional ways to install flucky is to compile the source code. There are
|
||||
two different ways to compile flucky from scratch. The easier ways is
|
||||
to use the pre-defined container image in the Makefile, which has included all
|
||||
dependancies to compile flucky. Alternatively, if all dependencies are met,
|
||||
flucky can also be compiled without the container image. Both variants are
|
||||
briefly described.
|
||||
two different ways to compile flucky from scratch. The easier ways is to use the
|
||||
pre-defined container image, which has included all dependencies to compile
|
||||
flucky. Alternatively, if all dependencies are met, flucky can also be compiled
|
||||
without the container image. Both variants are briefly described.
|
||||
|
||||
#### Compiling the source code via container image
|
||||
|
||||
To compile flucky via container image it's necessary, that a container runtime
|
||||
is installed. In the Makefile is predefined docker, but it's can be also used
|
||||
is installed. In the `Makefile` is predefined docker, but it's can be also used
|
||||
podman. Execute `make container-run/flucky` to start the compiling process.
|
||||
|
||||
```bash
|
||||
|
|
@ -69,8 +69,6 @@ make[1]: Directory „/home/markus/workspace/flucky“ is entered
|
|||
--volume /home/markus/workspace/flucky:/workspace \
|
||||
volkerraschek/build-image:latest \
|
||||
make go-build \
|
||||
UID=1000 \
|
||||
GID=1000 \
|
||||
VERSION=60ee044-git \
|
||||
GOOS=linux \
|
||||
GOARCH=amd64
|
||||
|
|
@ -89,7 +87,3 @@ go: finding github.com/satori/go.uuid v1.2.0
|
|||
Make sure you have installed go >= v1.12. Execute `make flucky` to compile
|
||||
flucky without a container-image. There should be a similar output as when
|
||||
compiling flucky via the container image.
|
||||
|
||||
## Enhancements
|
||||
|
||||
+ Provide flucky additionally as AUR and deb package
|
||||
|
|
|
|||
Loading…
Reference in New Issue