Sign inSign up

rchari/vdock

By rchari

•Updated 14 days ago

Docker based tool for maintaining hugo static sites.

Image
0

1.7K

rchari/vdock repository overview

⁠vdock

⁠Intro:

Vdock is a tool with an intergrated IDE for managing hugo⁠ site efficiently.
It provides features like

  • Integrated IDE (Cloud9)
  • Live preview(changes)
  • 1-click to create new post
  • 1-click to publish final site to github pages⁠
  • snippets(markdown) to ease content writing

Prerequisities(One time setup)

⁠Step 1 : Logon to your Github.com⁠ account.
⁠Step 2 : Create a repository for storing your Blog-Source
⁠Step 3 : Create a repository with name <Github-userid>.github.io to host your site.

Suppose If your github-userid is rchari66 then the repository name would be

rchari66.github.io

⁠Run :
⁠No Authentication & Deny Public Access
$ docker run -td -p 8288:8288 -p 8286:8286 rchari/vdock
⁠With Authentication & Deny Public Access
$ docker run -td -p 8288:8288 -p 8286:8286 -e AUTH=rchari:vdock rchari/vdock

open : http://localhost:8288/⁠

Vdock Config page


More Ways To Run vdock Securely

⁠With Authentication & Deny Public Access
$ docker run -td -p 8288:8288 -p 8286:8286 -e AUTH=<username>:<password> rchari/vdock
⁠No Authentication & Allow Public Access
$ docker run -td -p 8288:8288 -p 8286:8286 -e ALLOW_PUBLIC_ACCESS=YES rchari/vdock
⁠With Authentication & Allow Public Access
$ docker run -td -e AUTH=<username>:<password> ALLOW_PUBLIC_ACCESS=YES \
    -p 8288:8288 -p 8286:8286 rchari/vdock


⁠Configure vdock in config page
Show config page

Vdock Config page


⁠Step 1 : Enter your github id and click fetchRepositories button
fetch Repositories

Fetch Repositories


⁠Step 2 : Select repositories and Enter Other details.

Select hugo-sample-source and <Githuh-userid>.github.io repos for Blog Source: and Blog Destination:

Provide Github email and Github password and then Click on button Update Configure. This will create blog-source and mySite directries in the IDE.

Udate Config

Update configuration


⁠Configure config.toml(in blog-source/config.toml) for hugo

Make sure publishDir is set to ../MySite.

publishDir = "../MySite"

Update baseURL to https://<Github-userid>.github.io.

baseURL = "https://rchari66.github.io"

⁠Publish your site.

Simply goto publish page and click on Publish Changes(provide a commit message in textbox).

Wait for one or two minutes and then open https://<Github-userid>.github.io to view your site.

⁠In case the site in not available after couple of minutes then refer here⁠ for enabling github pages for your repository.


Refer : How to Create blog posts Using vdock⁠

⁠TODO: Enhancements/Imporovements:
  • Support for Gitlab & Bitbucket
  • Add Google analytics & disqus config to default themes.
  • One click theme(hugo) selection
  • Enhance this tool to ease kubernetes related stuff
  • 1-Click publish to S3(aws) Bucket
  • 1-Click to host the static site on ec2 instance
  • Support for dynamic services(Web services by Golang)

Tag summary

Content type

Image

Digest

sha256:e4bca112c…

Size

282.1 MB

Last updated

14 days ago

docker pull rchari/vdock