Giter Club home page Giter Club logo

wk's Introduction

Instant Gollum - Just Add Docker

gollum-portable is a self-contained, ready-to-use Gollum wiki in a dockerized form. If you have docker-compose or Docker Toolbox installed, all you need to do is:

$ git clone https://github.com/pjeby/gollum-portable my-wiki
$ cd my-wiki
$ ./docker/setup.sh
No docker-compose.yml found; initializing...
No gollum-settings.env found; creating...

--- Commit Log Settings ---
Your name [Anonymous]: Some Person
Your email [[email protected]]: [email protected]
Your timezone [UTC]: America/New_York

--- Wiki Settings ---
Gollum options [--h1-title --allow-uploads --live-preview]:

Settings saved to gollum-settings.env.  Use 'docker-compose up -d' to start, 
or edit docker-compose.yml to customize other settings first.

$ docker-compose up -d

And then open localhost:4567 in your browser. Congratulations! You now have a wiki that should autostart when you turn on your machine (or start your docker VM, if you're on Mac or Windows). You can re-run ./docker/setup.sh at any time to edit the settings, though you'll need to restart the service afterward.

Your wiki repository is the directory you cloned into, and you can back it up, or move it to another machine and docker-compose up -d there. (The two settings files, docker-compose.yml and gollum-settings.env, are not part of the repository, so if you copy it by cloning, you'll need to rerun the setup on the other machine.)

Once created, the two settings files can be copied into any gollum wiki directory and used to start a local dockerized wiki.

Mac and Windows users, please note: due to the limitations of docker-machine, you have to perform the above steps in a directory under /Users or C:\Users, respectively, and you may need to use your Docker Machine's IP rather than localhost to access the wiki.

wk's People

Contributors

animanathome avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.