https://github.com/juntaki/bucketwiki

Amazon S3 backed wiki witten in golang
https://github.com/juntaki/bucketwiki

golang s3 wiki wiki-engine

Last synced: 6 months ago
JSON representation

Amazon S3 backed wiki witten in golang

• Host: GitHub
• URL: https://github.com/juntaki/bucketwiki
• Owner: juntaki
• License: mit
• Created: 2016-10-04T14:49:06.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-01-03T16:06:59.000Z (almost 9 years ago)
• Last Synced: 2025-03-27T15:21:25.740Z (7 months ago)
• Topics: golang, s3, wiki, wiki-engine
• Language: Go
• Homepage: https://bucketwiki.herokuapp.com
• Size: 985 KB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Bucket Wiki

A simple Wiki system written in golang.

[![Build Status](https://travis-ci.org/juntaki/bucketwiki.svg?branch=master)](https://travis-ci.org/juntaki/bucketwiki)

[![Coverage Status](https://coveralls.io/repos/github/juntaki/bucketwiki/badge.svg?branch=master)](https://coveralls.io/github/juntaki/bucketwiki?branch=master)

[![Go Report Card](https://goreportcard.com/badge/github.com/juntaki/bucketwiki)](https://goreportcard.com/report/github.com/juntaki/bucketwiki)

![screenshot](https://github.com/juntaki/bucketwiki/blob/master/screenshot.gif?raw=true)

* Amazon S3 back-end, No need to setup/backup database.

* Easy to share a page to the public

## Deploy to Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Build and run

Set your bucket name and credentials to environment variable.

~~~

AWS_BUCKET_NAME=

AWS_BUCKET_REGION=

AWS_ACCESS_KEY_ID=

AWS_SECRET_ACCESS_KEY=

TWITTER_KEY=

TWITTER_SECRET=

URL=

WIKI_SECRET=

~~~

Get dependencies and build

~~~

go get -v

go build

~~~

Run and access http://localhost:8080/

## Run on Docker

~~~

docker run -d -p 8080:8080\

    -e AWS_BUCKET_NAME="" \

    -e AWS_BUCKET_REGION="" \

    -e AWS_ACCESS_KEY_ID="" \

    -e AWS_SECRET_ACCESS_KEY="" \

    -e TWITTER_KEY="" \

    -e TWITTER_SECRET="" \

    -e URL="" \

    -e WIKI_SECRET="" \

    juntaki/bucketwiki

~~~