Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.03 KB

README.md

File metadata and controls

67 lines (43 loc) · 2.03 KB
Raw

Go project version Go Report Card

Introduction

GoBlog is a blogging server to publish you markdown notes as neatly rendered articles.

Prerequisite

Go: You can install it use this automated script for Ubuntu.

Easy Deployment

  1. Download deploy script. Or follow instructions on Go website.

  2. Edit deploy.sh, update configurations part.

  3. Execute ./deploy.sh.

Configurations

DOC_DIR in deploy.sh: specify a directory for all articles to be served. deploy.sh will update conf/app.conf and genearte the final configuration file.

APPSEC is the string used to sign the website's cookies. By default, deploy.sh will genereate a 64-byte random string using /dev/urandom.

Managing articles

Recommended way to manage your notes locally is to create a notes folder and put everything inside. You can put it inside a cloud storage folder to prevent data lose, e.g., ~/Dropbox.

Your notes folder's content should look like this:

notes
  |----img
  |     |----img1.jpg
  |     |----img2.png
  |----nots1.md
  |----note2.md
  |----...

Then you can sync notes to server for publishing with rsync:

rsync -a --progress ~/Dropbox/notes/*.md $REMOTE_HOST:$DOC_DIR/
rsync -a --progress ~/Dropbox/notes/img/* $REMOTE_HOST:$REMOTE_GOPATH/src/$GOBLOG_INS/public/img

It doesn't matter which tool to use for syncing. Just make sure notes and images go to the correct folders.

Developing

  1. Check out code:
cd $GOPATH/src
git clone [email protected]:lpimem/goblog.git
  1. Install dependencies:
cd goblog
./dependency.sh