app

package

v0.0.0-...-f2b64ca Latest Latest Go to latest Published: Aug 10, 2021 License: GPL-3.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/TechMinerApps/portier

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	DB        dbConfig
	Telegram  bot.Config
	Template  string
	Log       logConfig
	BuntDB    buntDBConfig
	Telegraph telegraphConfig
}

Config is the configuration used in viper

var DefaultConfig Config = Config{
	DB:       dbConfig{Type: "sqlite", Path: "portier.db", Username: "portier", Password: "portier", Host: "localhost", Port: 3306, DBName: "portier"},
	Telegram: bot.Config{Token: ""},
	Template: "",
	Log:      logConfig{Mode: "", Path: ""},
	BuntDB:   buntDBConfig{Path: "feed.db"},
	Telegraph: telegraphConfig{
		Account:   1,
		ShortName: "Portier",
		Author:    "Portier",
		AuthorURL: "https://github.com/TechMinerApps/portier",
	},
}

DefaultConfig is the default config of Portier

type Portier ¶

type Portier struct {
	// contains filtered or unexported fields
}

Portier is the main app

func NewPortier ¶

func NewPortier() *Portier

NewPortier create a new portier object does not need config as parameter since this is the main object

func (*Portier) DB ¶

func (p *Portier) DB() *gorm.DB

DB returns the database instance portier used

func (*Portier) Logger ¶

func (p *Portier) Logger() log.Logger

Logger returns the logger portier used

func (*Portier) Poller ¶

func (p *Portier) Poller() feed.Poller

Poller return the poller portier used

func (*Portier) Start ¶

func (p *Portier) Start()

Start is used to start portier instance do not return error since error handling show be done within portier object

func (*Portier) Stop ¶

func (p *Portier) Stop(sig ...os.Signal)

Stop shutdown portier gracefully can accept a list of signals, print them if provided

func (*Portier) Wait ¶

func (p *Portier) Wait()

Wait is a blocking function that wait for portier to stop

Source Files ¶

View all Source files

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