bulge overview

BULGE - blog, image, paste, url

DESCRIPTION
	BULGE utilizes rc(1) and command line tools to display blog (blog)
	posts, an image board (image), pastebin entries (paste), or bookmarked
	URLs (url). Tagging and RSS 2.0 feeds have been implemented.

SETUP
	To enable BULGE, add:

		conf_enable_bulge

	to _werc/config in the site root or appropriate sub-directory.

	To configure BULGE, copy or create the following files in
	 _werc/bulge/, either in the site root or in the sub-directory
	you wish to activate (example files have been included in
	this distribution):

	_werc/bulge/config
		A list of variables that control various site options:

			site_type=paste # blog, image, url, paste
			site_tmp=_tmp # used by hoc on plan 9
			posts_per_page=10
			show_body=1
			show_date=1
			show_footer=0
			show_header=0
			show_img=0
			show_id=1
			show_link=0
			show_raw=1 # display a link to the raw text of the post
			show_sidebar=0
			show_tags=0
			show_title=1
			require_login=0 # if not logged in, redirect to /login
			allow_anon=1 # allow posts without logging in

	_werc/bulge/footer
		HTML or markdown that will appear as the foot of
		the BULGE content area.

	_werc/bulge/header
		HTML or markdown that will appear at the head of
		the BULGE content area.

	_werc/bulge/sidebar
		HTML or markdown that will appear on one side of
		the BULGE content area.

	Finally, sample stylesheets are provided in the directory
	pub/. Copy any of these to _werc/pub/style.css to try
	them out.

POSTS
	Posts are stored in the directory src/ relative to the
	site root or active sub-directory.

	Directory names in src/ that do not match the regular
	expression ^[0-9]*$ will not be included in the listing of
	posts that are displayed in the browser. However, such
	directories will still be accessible when called directly
	via the appropriate URL.

	A post's directory contains the following files and
	directories (an example post's directory has been
	included in this distribution):

		body
		date
		img/
		link
		tags/
		title

	The img/ directory contains images uploaded to the
	image board, including the original image and a
	thumbnail version, resized to no greater than 500
	pixels wide and 600 pixels tall.

	The tags/ directory contains one empty file named
	for each tag associated with the post.

	The site root contains a file named tags that is compr-
	ised of an index of the tags associated with each post.
	This index is consulted when searching for a given tag in
	the web browser.

UTILS
	bin/gf
		Parse RSS feeds from various sites into BULGE
		blog posts.
	bin/gp
		Create a new post on the command line.
	bin/gt
		Create an index of tags in the site root in a file
		named tags.

	For more information on these tools, read the source.

ADMIN
	Any tool that can create, alter, or delete flat files
	and directories is sufficient to administer a BULGE.

	Web-based login and administration utilizes werc's
	user authentication:

	http://$masterSite/login
		Login using werc's user authentation.

	After login, links to edit and delete will appear in
	each post's meta data.

	Web-based administration requires that the src/
	directory and its sub-directories are writable by
	the web server process.

REQUIREMENTS
	Plan 9
		Site type image uses the convert utility from
		ImageMagick to create thumbnails. A port is
		available from fgb's contrib directory.
	Unix
		Plan9port or 9base are required. Site type
		image requires ImageMagick and curl. Site
		type url also requires curl if the user employs
		the option to download remote URLs. These
		utilities may be swapped out for others by
		altering the source.

SOURCE
	http://plan9.stanleylieber.com/werc/apps/bulge.tgz
	https://code.stanleylieber.com/bulge

DEVELOPMENT SITES
	blog
		http://stanleylieber.com
	image
		http://img.stanleylieber.com
	paste
		http://okturing.com
	url
		http://url.stanleylieber.com

LICENSE
	Some code was borrowed from the existing blagh
	app, while other code was adapted from a previous
	project. In all cases, the code is released to the
	public domain.