2018-05-16 15:24:26 +00:00
|
|
|
# ekster
|
|
|
|
|
|
|
|
|
|
a microsub server
|
2018-02-19 20:39:22 +00:00
|
|
|
|
|
|
|
|
|
2018-05-16 15:40:57 +00:00
|
|
|
|
|
|
|
|
## Warning!
|
|
|
|
|
|
2018-02-19 20:39:22 +00:00
|
|
|
Very alpha: no warranty.
|
2018-05-16 15:40:57 +00:00
|
|
|
|
|
|
|
|
## Install ekster
|
|
|
|
|
|
|
|
|
|
ekster is build using [go](https://golang.org). To be able to install ekster
|
|
|
|
|
you need a Go environment. Use these commands to install the programs.
|
|
|
|
|
|
|
|
|
|
go get -u github.com/pstuifzand/ekster/cmd/eksterd
|
|
|
|
|
go get -u github.com/pstuifzand/ekster/cmd/ek
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `eksterd`
|
|
|
|
|
|
|
|
|
|
The command `eksterd` is the main server program. It will run a Microsub server.
|
|
|
|
|
`eksterd` also needs a Redis server. It's used to temporarily remember the items.
|
|
|
|
|
|
|
|
|
|
The first time you should call the command
|
|
|
|
|
|
|
|
|
|
eksterd new
|
|
|
|
|
|
2018-05-16 15:45:06 +00:00
|
|
|
This will generate a configuration file `backend.json` where it remembers the feeds.
|
2018-05-16 15:40:57 +00:00
|
|
|
|
|
|
|
|
### `ek`
|
|
|
|
|
|
|
|
|
|
The command `ek` is the command line client for Microsub server. It is able to
|
|
|
|
|
call the different functions of the Microsub server. It isn't needed to use `eksterd`, but
|
|
|
|
|
it can be useful. It can also be used with other servers that implement Microsub.
|
|
|
|
|
|
2018-05-16 19:38:24 +00:00
|
|
|
## Using Docker / Docker Compose
|
|
|
|
|
|
|
|
|
|
It's now also possible to use docker-compose to start a ekster server.
|
|
|
|
|
|
|
|
|
|
docker-compose pull
|
|
|
|
|
docker-compose run web new
|
|
|
|
|
docker-compose up
|
|
|
|
|
|
