bearblog

README

bearblog

Package bearblog is an Ambient plugin that provides basic blog functionality.

Import: github.com/ambientkit/plugin/generic/bearblog

Version: 1.0.0

Plugin Type

The plugin can be used as the following core types:

• Logger: false
• Storage System: false
• Router: false
• Template Engine: false
• Session Manager: false

Grants

The plugin request the following grants (19):

• Name: user.authenticated:read
  • Description: Show different menus to authenticated vs unauthenticated users.
• Name: user.authenticated:write
  • Description: Access to login and logout the user.
• Name: user.persist:write
  • Description: Access to set session as persistent.
• Name: plugin.setting:read
  • Description: Read own plugin settings.
• Name: plugin.setting:write
  • Description: Write own plugin settings.
• Name: site.post:read
  • Description: Read all site posts.
• Name: site.post:write
  • Description: Create and edit site posts.
• Name: site.scheme:read
  • Description: Read site scheme.
• Name: site.scheme:write
  • Description: Update the site scheme.
• Name: site.url:read
  • Description: Read the site URL.
• Name: site.url:write
  • Description: Update the site URL.
• Name: site.title:read
  • Description: Read the site title.
• Name: site.title:write
  • Description: Update the site title.
• Name: site.content:read
  • Description: Read home page content.
• Name: site.content:write
  • Description: Update home page content.
• Name: site.asset:write
  • Description: Access to write blog meta tags to the header and add a nav and footer.
• Name: site.funcmap:write
  • Description: Access to create global FuncMaps for templates.
• Name: router.route:write
  • Description: Access to create routes for editing the blog posts.
• Name: router.middleware:write
  • Description: Access to create global middleware to protect /dashboard/* routes from anonymous users.

Settings

The plugin has the follow settings (9):

• Name: Username
  • Type: input
  • Hidden: false
  • Default: admin
• Name: Password
  • Type: password
  • Hidden: true
  • Has Default: true
• Name: MFA Key
  • Type: password
  • Description: Generate an MFA key. Plugin must be enabled first.
    • URL: /dashboard/mfa
  • Hidden: false
• Name: Login URL
  • Type: input
  • Hidden: true
  • Default: admin
• Name: Author
  • Type: input
  • Hidden: false
• Name: Subtitle
  • Type: input
  • Hidden: true
• Name: Description
  • Type: textarea
  • Hidden: false
• Name: Footer
  • Type: textarea
  • Hidden: true
• Name: Allow HTML in Markdown
  • Type: checkbox
  • Hidden: false

Routes

The plugin has the following routes (17):

• Method: GET | Path: /blog
• Method: GET | Path: /{slug}
• Method: GET | Path: /login/{slug}
• Method: POST | Path: /login/{slug}
• Method: GET | Path: /dashboard/logout
• Method: GET | Path: /
• Method: GET | Path: /dashboard
• Method: POST | Path: /dashboard
• Method: GET | Path: /dashboard/reload
• Method: GET | Path: /dashboard/mfa
• Method: POST | Path: /dashboard/mfa
• Method: GET | Path: /dashboard/posts
• Method: GET | Path: /dashboard/posts/new
• Method: POST | Path: /dashboard/posts/new
• Method: GET | Path: /dashboard/posts/{id}
• Method: POST | Path: /dashboard/posts/{id}
• Method: GET | Path: /dashboard/posts/{id}/delete

Middleware

The plugin has middleware (1).

FuncMap

The plugin has the follow FuncMap items (8):

• {{bearblog_Authenticated}}
• {{bearblog_MFAEnabled}}
• {{bearblog_PageURL}}
• {{bearblog_PublishedPages}}
• {{bearblog_SiteFooter}}
• {{bearblog_SiteSubtitle}}
• {{bearblog_Stamp}}
• {{bearblog_StampFriendly}}

Assets

The plugin injects the following assets (3):

• Type: generic
  • Location: head
  • Tag Name: link
  • Attributes (2):
    • Name: rel | Value: canonical
    • Name: href | Value: {{if .canonical}}{{.canonical}}{{else}}{{bearblog_PageURL}}{{end}}
• Type: generic
  • Location: header
  • Inline: true
  • Path: template/partial/nav.tmpl
• Type: generic
  • Location: footer
  • Inline: true
  • Path: template/partial/footer.tmpl

Embedded Files

The plugin has embedded files.

Example Usage

package main

import (
	"encoding/base64"
	"log"
	"os"

	"github.com/ambientkit/ambient"
	"github.com/ambientkit/ambient/pkg/ambientapp"
	"github.com/ambientkit/plugin/generic/bearblog"
	"github.com/ambientkit/plugin/logger/zaplogger"
	"github.com/ambientkit/plugin/pkg/passhash"
	"github.com/ambientkit/plugin/storage/memorystorage"
)

func main() {
	// Generate a password hash.
	s, err := passhash.HashString(os.Args[1])
	if err != nil {
		log.Fatalln(err.Error())
	}

	plugins := &ambient.PluginLoader{
		// Core plugins are implicitly trusted.
		Router:         nil,
		TemplateEngine: nil,
		SessionManager: nil,
		// Trusted plugins are those that are typically needed to boot so they
		// will be enabled and given full access.
		TrustedPlugins: map[string]bool{},
		Plugins: []ambient.Plugin{
			bearblog.New(base64.StdEncoding.EncodeToString([]byte(s))),
		},
		Middleware: []ambient.MiddlewarePlugin{
			// Middleware - executes top to bottom.
		},
	}
	_, _, err = ambientapp.NewApp("myapp", "1.0",
		zaplogger.New(),
		ambient.StoragePluginGroup{
			Storage: memorystorage.New(),
		},
		plugins)
	if err != nil {
		log.Fatalln(err.Error())
	}
}

---

Docgen by Ambient

Documentation

Overview

Package bearblog is an Ambient plugin that provides basic blog functionality.

Index

• Constants
• type Plugin
  • func New(passwordHash string) *Plugin
  • func (p *Plugin) Assets() ([]ambient.Asset, ambient.FileSystemReader)
  • func (p *Plugin) DisallowAnon(h http.Handler) http.Handler
  • func (p *Plugin) FuncMap() func(r *http.Request) template.FuncMap
  • func (p *Plugin) GrantRequests() []ambient.GrantRequest
  • func (p *Plugin) Middleware() []func(next http.Handler) http.Handler
  • func (p *Plugin) PluginName() string
  • func (p *Plugin) PluginVersion() string
  • func (p *Plugin) Routes()
  • func (p *Plugin) Settings() []ambient.Setting

Examples

• New

Constants

const (
	// LoginURL allows user to set the login URL.
	LoginURL = "Login URL"
	// Author allows user to set the author.
	Author = "Author"
	// Subtitle allows user to set the Subtitle.
	Subtitle = "Subtitle"
	// Description allows user to set the description.
	Description = "Description"
	// Footer allows user to set the footer.
	Footer = "Footer"
	// AllowHTMLinMarkdown allows user to set if they allow HTML in markdown.
	AllowHTMLinMarkdown = "Allow HTML in Markdown"

	// Username allows user to set the login username.
	Username = "Username"
	// Password allows user to set the login password.
	Password = "Password"
	// MFAKey allows user to set the MFA key.
	MFAKey = "MFA Key"
)

Types

type Plugin

type Plugin struct {
	*ambient.PluginBase
	// contains filtered or unexported fields
}

Plugin represents an Ambient plugin.

func New

func New(passwordHash string) *Plugin

New returns an Ambient plugin that provides basic blog functionality.

Example

package main

import (
	"encoding/base64"
	"log"
	"os"

	"github.com/ambientkit/ambient"
	"github.com/ambientkit/ambient/pkg/ambientapp"
	"github.com/ambientkit/plugin/generic/bearblog"
	"github.com/ambientkit/plugin/logger/zaplogger"
	"github.com/ambientkit/plugin/pkg/passhash"
	"github.com/ambientkit/plugin/storage/memorystorage"
)

func main() {
	// Generate a password hash.
	s, err := passhash.HashString(os.Args[1])
	if err != nil {
		log.Fatalln(err.Error())
	}

	plugins := &ambient.PluginLoader{
		// Core plugins are implicitly trusted.
		Router:         nil,
		TemplateEngine: nil,
		SessionManager: nil,
		// Trusted plugins are those that are typically needed to boot so they
		// will be enabled and given full access.
		TrustedPlugins: map[string]bool{},
		Plugins: []ambient.Plugin{
			bearblog.New(base64.StdEncoding.EncodeToString([]byte(s))),
		},
		Middleware: []ambient.MiddlewarePlugin{
			// Middleware - executes top to bottom.
		},
	}
	_, _, err = ambientapp.NewApp("myapp", "1.0",
		zaplogger.New(),
		ambient.StoragePluginGroup{
			Storage: memorystorage.New(),
		},
		plugins)
	if err != nil {
		log.Fatalln(err.Error())
	}
}

func (*Plugin) Assets

func (p *Plugin) Assets() ([]ambient.Asset, ambient.FileSystemReader)

Assets returns a list of assets and an embedded filesystem.

func (*Plugin) DisallowAnon

func (p *Plugin) DisallowAnon(h http.Handler) http.Handler

DisallowAnon does not allow anonymous users to access the page.

func (*Plugin) FuncMap

func (p *Plugin) FuncMap() func(r *http.Request) template.FuncMap

FuncMap returns a callable function that accepts a request.

func (*Plugin) GrantRequests

func (p *Plugin) GrantRequests() []ambient.GrantRequest

GrantRequests returns a list of grants requested by the plugin.

func (*Plugin) Middleware

func (p *Plugin) Middleware() []func(next http.Handler) http.Handler

Middleware returns router middleware.

func (*Plugin) PluginName

func (p *Plugin) PluginName() string

PluginName returns the plugin name.

func (*Plugin) PluginVersion

func (p *Plugin) PluginVersion() string

PluginVersion returns the plugin version.

func (*Plugin) Routes

func (p *Plugin) Routes()

Routes sets routes for the plugin.

func (*Plugin) Settings

func (p *Plugin) Settings() []ambient.Setting

Settings returns a list of user settable fields.