README doc/AUTHORS.markdown doc/LICENCE.markdown doc/README.markdown doc/TODO.markdown @@ -1,10 +1,44 @@ -# Hash of user: password if authentication is wanted (HTTP Basic auth) -users: - nil +# Example configuration file for git-wiki +# ========================================= +# +# Currently none of the configuration options is required. +# In most cases, however, you will want to set the `wikiroot` +# option to some better location than ~/wiki. -# Directory in which the wiki pages live -wikiroot: nil # Defaults to $HOME/wiki -# Directory in which .git can be found, in case of e.g. subdirectories -repo_path: nil # Defaults to wikiroot + # Repository and filesystem information. + +# Directory in which the wiki pages live. +# +#wikiroot: nil # Defaults to ~/wiki + +# Directory in which .git can be found. Only use if /not/ the +# same as `wikiroot`. This is most often the case if you are +# using a subdirectory of a repository as the wiki directory. +# +# E.g. if `/home/bob/code/cool_project` is the project's Git +# repository but you want to use the `wiki/` subdirectory for +# the pages, you would configure thus: +# +# wikiroot: /home/bob/code/cool_project/wiki +# repo_path: /home/bob/code/cool_project +# +# git-wiki will do the right thing. +# +#repo_path: nil # Defaults to wikiroot + + + # Wiki parameters + +# Default- or "index" page of the wiki. +# +#home: Home # Defaults to this + + + # User accounts + +# user: password pairs if authentication is wanted (HTTP Basic auth) +# +#users: +# username: password config.yml.sample @@ -12,7 +12,7 @@ user_config = YAML.load_file ENV["GITWIKI_CONF"] rescue nil GitWiki = OpenStruct.new unless defined? GitWiki # Authentication -GitWiki.users = user_config["users"] +GitWiki.users = user_config["users"] || {} # Repository location GitWiki.wikiroot = File.expand_path(user_config["wikiroot"] || @@ -39,12 +39,11 @@ GitWiki.relative = if GitWiki.wikiroot != GitWiki.repo_path # Wiki setup -GitWiki.home = user_config["home"] || "/Home" +GitWiki.home = "/" + user_config["home"] || "Home" # Some type of a link to git-wiki version used -GitWiki.itself = user_config["gitwiki_page"] || - `git remote -v` =~ (/origin\s+git@(.+?)\.git/) && "http://#{$1.sub ":", "/"}/" || - "http://github.com/rue/git-wiki/" +GitWiki.itself = (`git remote -v` =~ (/origin\s+git@(.+?)\.git/) && "http://#{$1.sub ":", "/"}/") || + "http://github.com/rue/git-wiki/" # Git needs this. require "fileutils" environment.rb AUTHORS LICENSE README.textile TODO 98b760b7dd81b4462619284804467c1ea515cbe4 Eero Saynatkari projects@kittensoft.org http://github.com/rue/giraffe/commit/0f9512787aa468b3c7cf31585d21773f4bff6e19 0f9512787aa468b3c7cf31585d21773f4bff6e19 2008-11-27T20:44:09-08:00 2008-11-27T20:38:59-08:00 Updated doc stuff a bit. fa876d1a7b0ce1e120ceb6067b228be50c3de2bb Eero Saynatkari projects@kittensoft.org