cookbooks/bubbleupnp-server/README.md

   1 bubbleupnp-server Cookbook
   2 ==========================
   3
   4 This cookbook sets up a BubbleUPnP Server by Docker-compose.
   5 You can build BubbleUPnP Server Docker image too.
   6
   7 ## Contents
   8
   9 - [Requirements](#requirements)
  10     - [platforms](#platforms)
  11     - [packages](#packages)
  12 - [Attributes](#attributes)
  13 - [Usage](#usage)
  14     - [Recipes](#recipes)
  15         - [bubbleupnp-server::default](#bubbleupnp-serverdefault)
  16         - [bubbleupnp-server::docker-compose](#bubbleupnp-serverdocker-compose)
  17     - [Role Examples](#role-examples)
  18 - [License and Authors](#license-and-authors)
  19
  20 ## Requirements
  21
  22 ### platforms
  23
  24 - Debian >= 10.x
  25 - Ubuntu >= 18.04
  26 - CentOS,RHEL >= 7.9
  27
  28 ### packages
  29 - none.
  30
  31 ## Attributes
  32
  33 |Key|Type|Description, example|Default|
  34 |:--|:--|:--|:--|
  35 |`['bubbleupnp-server']['Dockerfile']['FROM']`|String|Base image in the `Dockerfile`.|See `attributes/default.rb`|
  36 |`['bubbleupnp-server']['docker-compose']['autopilot']`|Hash|Autopilot configurations.|See `attributes/default.rb`|
  37 |`['bubbleupnp-server']['docker-compose']['app_dir']`|String||`"#{node['docker-grid']['compose']['app_dir']}/bubbleupnp-server"`|
  38 |`['bubbleupnp-server']['docker-compose']['data_dir']`|String||`"#{node['bubbleupnp-server']['docker-compose']['app_dir']}/data"`|
  39 |`['bubbleupnp-server']['docker-compose']['dot_env']`|Hash|`.env` configurations.|See `attributes/default.rb`|
  40 |`['bubbleupnp-server']['docker-compose']['config']`|Hash|`docker-compose.yml` configurations.|See `attributes/default.rb`|
  41
  42 ## Usage
  43
  44 ### Recipes
  45
  46 #### bubbleupnp-server::default
  47
  48 This recipe does nothing.
  49
  50 #### bubbleupnp-server::docker-compose
  51
  52 This recipe generates a `docker-compose.yml` for the BubbleUPnP Server.
  53
  54 ### Role Examples
  55
  56 - `roles/bubbleupnp-server-on-docker.rb`
  57
  58 ```ruby
  59 name 'bubbleupnp-server-on-docker'
  60 description 'BubbleUPnP Server on Docker'
  61
  62 run_list(
  63   # see https://osdn.net/projects/metasearch/scm/git/grid-chef-repo/blobs/master/roles/docker-new-repo.rb
  64   'role[docker]',
  65   'recipe[bubbleupnp-server::docker-compose]',
  66 )
  67
  68 #env_run_lists
  69
  70 #default_attributes
  71
  72 override_attributes(
  73   'bubbleupnp-server' => {
  74     'docker-compose' => {
  75       'dot_env' => {
  76         # use the official image
  77         # https://hub.docker.com/r/bubblesoftapps/bubbleupnpserver
  78         'REGISTRY' => 'bubblesoftapps',
  79         'NAME' => 'bubbleupnpserver',
  80         'VER' => 'latest',
  81         # Local build
  82         #'REGISTRY' => 'yourname',
  83         #'NAME' => 'bubbleupnpserver',
  84         #'VER' => '0.9-6',
  85       },
  86       'config' => {
  87         'services' => {
  88           'bubbleupnp-server' => {
  89             'restart' => 'no',
  90           },
  91         },
  92       },
  93     },
  94   },
  95 )
  96 ```
  97
  98 ## License and Authors
  99
 100 - Author:: whitestar at osdn.jp
 101
 102 ```text
 103 Copyright 2019-2022, whitestar
 104
 105 Licensed under the Apache License, Version 2.0 (the "License");
 106 you may not use this file except in compliance with the License.
 107 You may obtain a copy of the License at
 108
 109     http://www.apache.org/licenses/LICENSE-2.0
 110
 111 Unless required by applicable law or agreed to in writing, software
 112 distributed under the License is distributed on an "AS IS" BASIS,
 113 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 114 See the License for the specific language governing permissions and
 115 limitations under the License.
 116 ```