README
¶
Aeridya
Single domain webserver/CMS written and extendable using Golang
Description
Aeridya extends the built-in HTTP functionality of Golang to deliver Web Pages where the logic is written in Golang. The final render of the webpage uses Golang's Templating System to deliver static pages. This provides you with the flexibility of HTML/CSS/JavaScript in an easy package, and the speed to do server side logic in Go. The final application is recommended to run via a reverse proxy; specifically NGINX. More documentation on this will be written once the application is further along.
Aeridya applications should consist of a Theme which routes incomming connections to the functions that it containts. A Theme is recommended to contain Pages, which a Page consists of a set of instructions for each of the main HTTP Requests, ie. "GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD".
See "basic" for an example application. You may also want to see "theme.go" on how the basic theme is implemented.
Using Aeridya
To use Aeridya in your application, you must have a configuration file setup. "See basic/conf" for the necessary basic configuration.
The following must be set in the configuration file:
## Configuration for basic site using Aeridya
## A "#" denotes a comment in the configuration
## A ";" denotes the beginning of a section
## The Aeridya Section is required by the Aeridya Core
;Aeridya
# Log location
## NOTE: use stdout to get term output
Log = stdout
# Port to listen on
Port = 8000
# Domain name
Domain = domain.com
# HTTPS Setting.
## NOTE: Aeridya itself does not handle HTTPS, and HTTPS
## is only availble when used via a reverse proxy
## This setting will set the internal URL for routing
HTTPS = false
# Development Mode
## NOTE: In production, it is recommended to disable
Development = true
# Workers
## Sets allowed connections able to do work
Workers = 10
Documentation
¶
Index ¶
- Constants
- Variables
- func AddHandler(priority int, handle func(http.Handler) http.Handler)
- func Create(conf string) error
- func DeleteHandler(priority int)
- func GetHandler() map[int]func(http.Handler) http.Handler
- func Info() string
- func Run() error
- func Version() string
- type Response
- func (r *Response) Bad(status int, msg string)
- func (r *Response) Error(msg string)
- func (r *Response) GetData(key string) (string, bool)
- func (r *Response) GetDataValues(keys ...string) ([]string, bool)
- func (r *Response) Good(status int)
- func (r *Response) Redirect(status int, url string)
- func (r *Response) Return(status int, data []byte)
Constants ¶
const ( //NAME is the name of the librar NAME = "Aeridya" //MAJORVER is the Major Version MAJORVER = "1" //MINORVER is the Minor Version MINORVER = "0" //RELEASEVER is the Release Version RELEASEVER = "2" //DESC is a description of the library DESC = "Server and CMS" )
Variables ¶
Functions ¶
func AddHandler ¶
AddHandler adds an http Handler to the map, requires a priority set
func DeleteHandler ¶
func DeleteHandler(priority int)
DeleteHandler removes an httpHandler based on the priority set
func GetHandler ¶
GetHandler returns the current handler map
Types ¶
type Response ¶
type Response struct {
// W reference to the http.ResponseWriter
W http.ResponseWriter
// R reference to the http.Request
R *http.Request
// Status of the current request
Status int
// Err contains the connection error if applicable
Err error
// Data holds data as the request is passed in Aeridya
Data interface{}
}
Response is a convenience struct containing data for Aeridya to parse the connection for a user
func (*Response) Bad ¶
Bad takes a status and returns connection as an error // Recommended: 400+, 500+
func (*Response) GetData ¶ added in v1.0.1
GetData retrieves the data from the POST request Takes a key and returns the data, boolean to check if found converts the []string from the response to a string
func (*Response) GetDataValues ¶ added in v1.0.2
func (*Response) Good ¶
Good takes a status and completes the connection // Recommend: 200 status code
Source Files
Directories