syndication

command module
v0.0.0-...-dc8ef24 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 7, 2021 License: AGPL-3.0 Imports: 14 Imported by: 0

README

codecov BCH compliance

Syndication - A simple news aggregation server

Features

  • JSON REST API
  • Let's Encrypt through Echo framework (experimental)
  • Support for SQLite, MySQL and PostgreSQL

Building

$ go build

Usage

$ syndication --config synd.yaml

Configuration

# Authorization Secret. If not specified, syndication will
# generate one for you.
auth_secret: secret_cat

# Database configuration.
database:
  # Connection string for an SQL implementation. Examples:
  #   - mysql: user:password@/dbname?charset=utf8&parseTime=True&loc=Local
  #   - postgres: host=myhost port=myport user=synd dbname=synd password=mypassword
  connection: /var/lib/syndication.db

  # Connection Type. Can be one of the following:
  #   - mysql
  #   - postgres
  #   - sqlite3
  type: sqlite3

# Server configuration
host:
  address: localhost
  port: 8080

# Synchronization Configuration
sync:
  # How often to sync feeds
  interval: 15m0s

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
controller
rest
Package controller provides Syndication's REST API.
Package controller provides Syndication's REST API.
sql
Package repo provides routines to operate on Syndications SQL repo using models defined in the models package to map data in said repo.
Package repo provides routines to operate on Syndications SQL repo using models defined in the models package to map data in said repo.
Package services is a generated GoMock package.
Package services is a generated GoMock package.
Package utils provides utilities for other packages
Package utils provides utilities for other packages

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL