Skip to content

Azrael808/chef-tiddlywiki5

Repository files navigation

tiddlywiki5-cookbook

Currently downloads and configures TiddlyWiki5 from source as a NodeJS application, optionally configuring Nginx as a proxy with or without LDAP-based authentication.

Supported Platforms

Currently tested on the following distros:

  • CentOS (6.5)
  • Ubuntu (14.04)

Not currently compatible with Chef 12, because of it's dependency on the application_nginx cookbook: poise/application_nginx#20

Attributes

Key Type Description Default
['tiddlywiki5']['user'] String OS user account who will "own" the TW5 installation. tw5
['tiddlywiki5']['tw5_path'] String Base directory used to contain the TW5 installation. /srv/tw5
['tiddlywiki5']['site_hostname'] String Hostname through which the TW5 instance will be accessed tiddlywiki5.com
['tiddlywiki5']['tw5_port'] Integer Port that the TW5 instance should bind to. 8080
['tiddlywiki5']['nodejs']['nginx_proxy'] Boolean Decides whether or not to configure Nginx. true
['tiddlywiki5']['nodejs']['ldap_auth'] Boolean Decides whether or not to configure LDAP authentication. true
['tiddlywiki5']['nodejs']['ldap_basedn'] String Base/suffix of the LDAP directory. dc=example,dc=com
['tiddlywiki5']['nodejs']['ldap_url'] String URL used to query the LDAP directory when authenticating users. ldap://ldap.example.com:389/dc=example,dc=com?uid?sub?(objectClass=inetorgperson)
['tiddlywiki5']['nodejs']['ldap_binddn'] String Distinguished Name to bind to the LDAP directory as. uid=tiddlywiki,ou=Service Accounts,dc=example,dc=com
['tiddlywiki5']['nodejs']['ldap_binddn_password'] String Password to bind to the LDAP directory as. changeme
['tiddlywiki5']['nodejs']['ldap_secure_name'] String Name of site as displayed by the auth dialog. Example TW5

Usage

If you have Vagrant and the ChefDK installed and configured locally, you should be able to run vagrant up to get a working installation. Override the attributes above to tweak the deployment.

To include this cookbook in a Chef run, simply add the tiddlywiki5::default recipe to the run list.

tiddlywiki5::default

Include tiddlywiki5 in your node's run_list:

{
  "run_list": [
    "recipe[tiddlywiki5::default]"
  ]
}

License and Authors

Author:: AzTek Native Ltd. ([email protected])

Copyright 2015 AzTek Native Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

Chef cookbook for the deployment of TiddlyWiki5.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published