install.rst 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. Installation
  2. =============
  3. Installing larigira is quite simple. You can install latest version from PyPI
  4. using ``pip install larigira``. Or you can ``git clone
  5. https://git.lattuga.net/boyska/larigira.git`` and run ``python setup.py install``.
  6. As always, the usage of a virtualenv is recommended.
  7. The only supported python version is 3.4.
  8. Configuration
  9. ---------------
  10. larigira use MPD in a peculiar way. It can use mpd internal library, but it can
  11. also work with "regular" local files, outside of the library. To do so,
  12. however, it requires you to connect to MPD through the UNIX socket instead of
  13. the TCP port.
  14. So how to create this setup?
  15. inside ``~/.mpdconf``, add the following line::
  16. bind_to_address "~/.mpd/socket"
  17. For larigira, you need to set the ``MPD_HOST`` environment variable to
  18. ``$HOME/.mpd/socket``. If you don't do this, you'll find many::
  19. 15:37:10|ERROR[Player:93] Cannot insert song file:///tmp/larigira.1002/audiogen-randomdir-8eoklcee.mp3
  20. Traceback (most recent call last):
  21. File "/home/user/my/ror/larigira/larigira/mpc.py", line 91, in enqueue
  22. mpd_client.addid(uri, insert_pos)
  23. File "/home/user/.virtualenvs/larigira3/lib/python3.5/site-packages/python_mpd2-0.5.5-py3.5.egg/mpd.py", line 629, in decorator
  24. return wrapper(self, name, args, bound_decorator(self, returnValue))
  25. File "/home/user/.virtualenvs/larigira3/lib/python3.5/site-packages/python_mpd2-0.5.5-py3.5.egg/mpd.py", line 254, in _execute
  26. return retval()
  27. File "/home/user/.virtualenvs/larigira3/lib/python3.5/site-packages/python_mpd2-0.5.5-py3.5.egg/mpd.py", line 623, in decorator
  28. return function(self, *args, **kwargs)
  29. File "/home/user/.virtualenvs/larigira3/lib/python3.5/site-packages/python_mpd2-0.5.5-py3.5.egg/mpd.py", line 384, in _fetch_item
  30. pairs = list(self._read_pairs())
  31. File "/home/user/.virtualenvs/larigira3/lib/python3.5/site-packages/python_mpd2-0.5.5-py3.5.egg/mpd.py", line 311, in _read_pairs
  32. pair = self._read_pair(separator)
  33. File "/home/user/.virtualenvs/larigira3/lib/python3.5/site-packages/python_mpd2-0.5.5-py3.5.egg/mpd.py", line 302, in _read_pair
  34. line = self._read_line()
  35. File "/home/user/.virtualenvs/larigira3/lib/python3.5/site-packages/python_mpd2-0.5.5-py3.5.egg/mpd.py", line 291, in _read_line
  36. raise CommandError(error)
  37. mpd.CommandError: [400] {addid} Access denied
  38. Options
  39. ~~~~~~~~~~
  40. Options will be presented "grouped" to make them more easily understandable. This is just for documentation
  41. purposes, they don't need to be divided in the configuration.
  42. Options values are assumed to be JSON formatted. For strings and numbers, this makes no difference. For
  43. booleans, this means that the only valid values are ``true`` and ``false``. For lists and objects, read a JSON
  44. reference or learn from examples.
  45. To set an option, you must set an environment variable with the name ``LARIGIRA_OPTIONNAME``.
  46. General
  47. ^^^^^^^^^^^^^
  48. MPD_HOST
  49. This option let you set the way to connect to your MPD server. Please remind that for complete larigira
  50. operatoin you should set the path to a UNIX domain socket, not ``localhost``
  51. MPD_PORT
  52. If you are not using a socket, but a TCP address (which is *not* suggested), this is how you can specify the
  53. port.
  54. DEBUG
  55. you can set it to ``true`` or ``false``. Defaults to ``false``.
  56. TMPDIR
  57. The base for larigira tmpdir. Please note that larigira will create its own directory inside this
  58. temporary directory. This defaults to the system-wide ``$TMPDIR``, or to ``/tmp/`` if not ``TMPDIR`` is
  59. not set. Choose it wisely, keeping in mind that in this directory a lot of cache files will be stored, and
  60. could therefore require hundreds of MB.
  61. Events
  62. ^^^^^^^^^
  63. CONTINOUS_AUDIOSPEC
  64. when the playlist is too short, larigira picks something new. How? this is controlled by this variable.
  65. This variable should be set to the JSON representation of an audiospec describing how to generate new
  66. audios. The default is ``{"kind": "mpd", "howmany": 1}``. You could, for example, change it to
  67. ``{ "kind": "randomdir", "paths": ["/var/music"], "howmany": 10}``
  68. EVENT_FILTERS
  69. See :doc:`eventfilters`
  70. LOG_CONFIG
  71. Path to an INI-formatted file to configure logging. See `python logging documentation
  72. <https://docs.python.org/2/library/logging.config.html#logging-config-dictschema>`_
  73. Internals
  74. ^^^^^^^^^^^^^^
  75. These are options you probably don't want to change, unless you want to debug
  76. CACHING_TIME
  77. larigira needs an estimate on how much time an audiogenerator will need. This option sets this. The
  78. default is 10 (seconds). If you set it too low, the events will be scheduled with some delay
  79. CHECK_SECS
  80. The interval (in seconds) that will trigger a check for the playlist length. Set it too low, and you'll be
  81. consuming resource with no usage. Set it too high and you might miss some moment of playlist shortage.
  82. The default is 20
  83. EVENT_TICK_SECS
  84. The interval (in seconds) that will trigger a check on the events to see if there's something to schedule.
  85. This also determines how much time in advance you can add/delete/change an event for the change to be
  86. effective.
  87. SCRIPTS_PATH
  88. This options controls the path where scripts will be looked for. This is a single path, not a list. The
  89. default is ``$XDG_CONFIG_DIR/larigira/scripts/`` which might boil down to
  90. ``$HOME/.config/larigira/scripts/``
  91. DB_URI
  92. The path to the events database. The default is ``$XDG_CONFIG_DIR/larigira/db.json``
  93. MPD_WAIT_START
  94. When larigira starts, it will try to connect to MPD. If MPD doesn't look ready, larigira will wait until
  95. it is. This makes larigira depend on MPD. However, this also makes it easier to run larigira at boot
  96. without complex dependency on MPD to be fully started and listening. You can disable this behavior setting
  97. this to ``false``
  98. MPD_WAIT_START_RETRYSECS
  99. The behavior described for the previous option requires polling. This variable lets you customize the
  100. polling frequency, expressed in seconds. The default is ``5``.
  101. Web interface
  102. ^^^^^^^^^^^^^^^^
  103. FILE_PATH_SUGGESTION
  104. A list of paths. Those paths will be scanned for suggestions in audiogenerator forms.
  105. UI_CALENDAR_FREQUENCY_THRESHOLD
  106. The "calendar" view in the UI will omit events that occur too frequently, to avoid noise. This variable is
  107. the threshold, in seconds. Defaults to 4 hours.
  108. BOOTSTRAP_SERVE_LOCAL
  109. larigira can serve every js and css by itself. However, you might like to make the user download standard
  110. libraries from CDNs. In that case, set this variable to ``false``.
  111. Localization
  112. ++++++++++++++
  113. Localization support in larigira is basic to say the least. However, something can be done.
  114. Dates (not consistently! sigh) are formatted according to locale.
  115. LARIGIRA_BABEL_DEFAULT_LOCALE
  116. The short language code you want to use when the user doesn't specify any. Values are in the form
  117. ``it``, ``en``, ``en-US``...
  118. LARIGIRA_UI_CALENDAR_DATE_FMT
  119. The format to show in ``/db/calendar`` page. The format is specified `here <http://babel.pocoo.org/en/latest/dates.html>`_. Default is ``medium``.
  120. As an example, ``eee dd LLL`` will show ``Sun 10 Mar`` for english, and ``dom 10 mar`` for italian.