peter/ekster
1
0
Fork 0
Code Issues 3 Pull Requests Projects 3 Releases 1 Wiki Activity
An implementation of the Microsub server spec
177 Commits 3 Branches 7 Tags 6.4 MiB
Go 85.2%
HTML 14.5%
PLpgSQL 0.2%
Shell 0.1%
b62f719221
Go to file
Peter Stuifzand b62f719221 cli: improve "mark_read" command
2018-05-16 17:54:34 +02:00
cmd Load config files from users config dir 2018-05-16 17:34:40 +02:00
microsub Improve handling of missing author and content 2018-04-11 18:47:57 +02:00
pkg cli: improve "mark_read" command 2018-05-16 17:54:34 +02:00
vendor Add redis caching of http requests and hub subscription 2018-05-03 21:50:16 +02:00
.drone.yml Fix drone.yml 2018-05-16 17:27:40 +02:00
.gitignore Add server binary to gitignore 2018-02-19 20:24:33 +01:00
Dockerfile Call new server from Dockerfile 2018-05-16 17:25:15 +02:00
LICENSE Create LICENSE 2018-02-19 21:41:31 +01:00
README.md Add filename of configuration file to README.md 2018-05-16 17:45:06 +02:00

README.md

ekster

a microsub server

Warning!

Very alpha: no warranty.

Install ekster

ekster is build using go. 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

This will generate a configuration file backend.json where it remembers the feeds.

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.