Running Couchpotato in a SmartOS Zone

.README.md

Couchpotato on SmartOS

Introduction

Documentation on installing and setting up Couchpotato on a SmartOS base64 14.3.0 zone. These instructions assume a fresh zone creation of image 62f148f8-6e84-11e4-82c5-efca60348b9f.

Prerequisites

Make sure to copy the following line by line and confirm that each runs successfully. All of the following are run from the root shell.

pkgin -fy up
pkgin -y fug
pkgin -y in py27-sqlite3 py27-lxml py27-OpenSSL git
groupadd -g 500 couch
useradd -m -c "Couchpotato User" -u 500 -g couch couch
passwd -N couch
sed -i.bak 's/^TZ=.*$/TZ=America\/Los_Angeles/' /etc/default/init

Installation

su - couch
cd
export TZ=America/Los_Angeles
echo "export TZ=America/Los_Angeles" >> .profile
git clone https://github.com/RuudBurger/CouchPotatoServer.git couchpotato
cd couchpotato
python CouchPotato.py --console_log

At this point Couchpotato should be running in the foreground. Following are instructions for getting the SMF service up and running. Test the server by seeing if the web interface is accessible using the information below. Then press CTRL+c to exit the process and CTRL+d to exit the su sub-shell.

Install SMF Service

Perform the following from the root account to turn couchpotato into a managed service.

curl -sk https://gist.githubusercontent.com/baetheus/d7dc8b01a89ecdd78ef9/raw/couchpotato.xml > $HOME/couchpotato.xml
svccfg import $HOME/couchpotato.xml
svcadm enable couchpotato

Accessibility

The service should now be available at http://<hostname/ip>:5050

Commentary

Since I run each of my services on their own zone with a static ip and dns configuration, I like to change the port binding to 80 on my internal home network. Thus, the net_privaddr privilege has been added to the service to allow binding to privileged ports. Additionally, if you're like me and are running your media server on smartos or another illumos derivative, you might want to look into using lofs to map your media filesystem to multiple zones. This is the reason for manually picking uid and gid for the couch user and group. Feel free to contact me if you have questions on this process. Or hit up #smartos on the Freenode irc network.

Changelog

20150910

• Added py27-lxml and py27-OpenSSL to package install step.
• Changed sed -i to sed -i.bak to cope with freebsd sed.

20150407

• Update linke to point to baetheus github account instead of slashtact.

20150208

• Updated various references and cleaned up some commands.
• Added local timezone references.

20150111

• Initial Gist
• Added SMF file

couchpotato.xml

<?xml version='1.0'?>
<!DOCTYPE service_bundle SYSTEM '/usr/share/lib/xml/dtd/service_bundle.dtd.1'>
<service_bundle type='manifest' name='export'>
  <service name='site/couchpotato' type='service' version='0'>
    <create_default_instance enabled='true'/>
    <single_instance/>
    <dependency name='network' grouping='require_all' restart_on='error' type='service'>
      <service_fmri value='svc:/milestone/network:default'/>
    </dependency>
    <dependency name='filesystem' grouping='require_all' restart_on='error' type='service'>
      <service_fmri value='svc:/system/filesystem/local'/>
    </dependency>
    <exec_method name='start' type='method' exec='/opt/local/bin/python /home/couch/couchpotato/CouchPotato.py --quiet --daemon' timeout_seconds='60'>
      <method_context>
        <method_credential user='couch' group='couch' privileges='basic,net_privaddr'/>
        <method_environment>
          <envvar name='PATH' value='/usr/local/sbin:/usr/local/bin:/opt/local/sbin:/opt/local/bin:/usr/sbin:/usr/bin:/sbin'/>
          <envvar name='HOME' value='/home/couch'/>
        </method_environment>
      </method_context>
    </exec_method>
    <exec_method name='stop' type='method' exec=':kill' timeout_seconds='60'/>
    <property_group name='startd' type='framework'>
      <propval name='duration' type='astring' value='contract'/>
      <propval name='ignore_error' type='astring' value='core,signal'/>
    </property_group>
    <stability value='Evolving'/>
    <template>
      <common_name>
        <loctext xml:lang='C'>CouchPotato</loctext>
      </common_name>
    </template>
  </service>
</service_bundle>