conf/afm-unit-debug.conf.in

   1 ;---------------------------------------------------------------------------------
   2 ; File:
   3 ;
   4 ;    afm-unit.conf
   5 ;
   6 ; Role:
   7 ;
   8 ;    Configure how installation of widget produces unit files for systemd
   9 ;
  10 ; Processing and format:
  11 ;
  12 ;    1. File load
  13 ;
  14 ;           Lines beginning with ; are firstly removed
  15 ;
  16 ;    2. File instantiation
  17 ;
  18 ;           Mustache (extended) substitutions are applied using JSON
  19 ;           data deduced from config.xml file of the widget.
  20 ;
  21 ;    3. Extraction of units
  22 ;
  23 ;           Extract produced units, pack it (remove empty lines and directives)
  24 ;
  25 ; Directives:
  26 ;
  27 ;    Any directive occupy one whole line starting with %
  28 ;
  29 ;     - %nl
  30 ;
  31 ;             produce an empty line at the end
  32 ;
  33 ;     - %begin systemd-unit
  34 ;     - %end systemd-unit
  35 ;
  36 ;             delimit the produced unit
  37 ;
  38 ;     - %systemd-unit user
  39 ;     - %systemd-unit system
  40 ;
  41 ;             tells the kind of unit (user/system)
  42 ;
  43 ;     - %systemd-unit service NAME
  44 ;     - %systemd-unit socket NAME
  45 ;
  46 ;             gives the name and type of the unit
  47 ;
  48 ;     - %systemd-unit wanted-by NAME
  49 ;
  50 ;             tells to install a link to unit in the wants of NAME
  51 ;
  52 ; Setting variables:
  53 ;
  54 ;    AFM uses the feature of systemd that completely ignores options prefixed
  55 ;    with X-
  56 ;
  57 ;    Consequently, options starting with X-AFM- are recorded as public data
  58 ;    about the application and options starting starting with X-AFM-- are
  59 ;    recorded as private data.
  60 ;
  61 ;    Examples:
  62 ;
  63 ;        X-AFM-description={{description}}
  64 ;
  65 ;              Records the description of the unit in the field "description"
  66 ;              of both the public and private object describing the unit.
  67 ;
  68 ;        X-AFM--wgtdir={{:#metadata.install-dir}}
  69 ;
  70 ;              Records the installation directory path in the field "wgtdir"
  71 ;              of the private object only.
  72 ;
  73 ;---------------------------------------------------------------------------------
  74 {{#targets}}
  75
  76 ;---------------------------------------------------------------------------------
  77 ;----        P R O V I D E D   U N I T S                                      ----
  78 ;---------------------------------------------------------------------------------
  79 %begin systemd-unit
  80
  81 # auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
  82 %nl
  83
  84 [Unit]
  85 Description={{description}}
  86 X-AFM-description={{description}}
  87 X-AFM-name={{name.content}}
  88 X-AFM-shortname={{name.short}}
  89 X-AFM-id={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
  90 X-AFM-version={{version}}
  91 X-AFM-author={{author.content}}
  92 X-AFM-author-email={{author.email}}
  93 X-AFM-width={{width}}
  94 X-AFM-height={{height}}
  95 X-AFM--ID={{id}}
  96 X-AFM--target-name={{:#target}}
  97 X-AFM--content={{content.src}}
  98 X-AFM--type={{content.type}}
  99 X-AFM--wgtdir={{:#metadata.install-dir}}
 100 X-AFM--workdir={{&#metadata.app-data-dir}}/{{id}}
 101 %nl
 102
 103 Wants=sockets.target
 104
 105 # Adds check to smack
 106 ConditionSecurity=smack
 107 %nl
 108
 109 # Automatic bound to required api
 110 {{#required-api}}
 111 {{#value=auto|ws}}
 112 BindsTo=afm-api-ws-{{name}}.socket
 113 After=afm-api-ws-{{name}}.socket
 114 {{/value=auto|ws}}
 115 {{/required-api}}
 116 %nl
 117
 118 [Service]
 119 EnvironmentFile=-@afm_confdir@/unit.env.d/*
 120 SmackProcessLabel=User::App::{{id}}
 121 SuccessExitStatus=0 SIGKILL
 122
 123 {{#required-permission}}
 124   {{#urn:AGL:permission::platform:no-oom}}      OOMScoreAdjust=-500             {{/urn:AGL:permission::platform:no-oom}}
 125   {{#urn:AGL:permission::partner:real-time}}    IOSchedulingClass=realtime      {{/urn:AGL:permission::partner:real-time}}
 126 #  {{^urn:AGL:permission::partner:real-time}}    RestrictRealtime=on             {{/urn:AGL:permission::partner:real-time}}
 127   {{#urn:AGL:permission::public:display}}       SupplementaryGroups=display     {{/urn:AGL:permission::public:display}}
 128   {{^urn:AGL:permission::public:syscall:clock}} SystemCallFilter=~@clock        {{/urn:AGL:permission::public:syscall:clock}}
 129 {{/required-permission}}
 130 %nl
 131
 132 WorkingDirectory=-{{&#metadata.app-data-dir}}/{{id}}
 133 ExecStartPre=/bin/mkdir -p {{&#metadata.app-data-dir}}/{{id}}
 134 Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 135 Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}
 136
 137 ; Needed to enable debug
 138 Environment=AFM_ID={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 139 EnvironmentFile=-/var/run/afm-debug/{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}.env
 140
 141 %systemd-unit user
 142 {{#required-permission.urn:AGL:permission::public:hidden}}\
 143 %systemd-unit service afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 144 {{/required-permission.urn:AGL:permission::public:hidden}}\
 145 {{^required-permission.urn:AGL:permission::public:hidden}}\
 146 %systemd-unit service afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 147 {{/required-permission.urn:AGL:permission::public:hidden}}\
 148
 149 Environment=LD_LIBRARY_PATH=$ORIGIN/lib
 150
 151 SyslogIdentifier=afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 152 StandardInput=null
 153 StandardOutput=journal
 154 StandardError=journal
 155
 156 ;---------------------------------------------------------------------------------
 157 ;----   text/html  application/vnd.agl.native  application/vnd.agl.service    ----
 158 ;---------------------------------------------------------------------------------
 159 {{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 160
 161 X-AFM--http-port={{:#metadata.http-port}}
 162
 163 ExecStart=/usr/bin/afb-daemon \
 164         --name afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}} \
 165         --rootdir={{:#metadata.install-dir}} \
 166         --workdir={{&#metadata.app-data-dir}}/{{id}} \
 167         --port={{:#metadata.http-port}} \
 168         --token=HELLO \
 169         --verbose \
 170         --monitoring \
 171         {{#content.type=application/vnd.agl.service}} \
 172                 --roothttp=. \
 173         {{/content.type=application/vnd.agl.service}} \
 174         {{^content.type=application/vnd.agl.service}} \
 175                 {{#required-permission.urn:AGL:permission::public:no-htdocs}}\
 176                         --roothttp=. \
 177                 {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 178                 {{^required-permission.urn:AGL:permission::public:no-htdocs}}\
 179                         --roothttp=htdocs \
 180                 {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 181         {{/content.type=application/vnd.agl.service}} \
 182         {{#required-permission.urn:AGL:permission::public:applications:read}}\
 183                 --alias=/icons:{{:#metadata.icons-dir}} \
 184         {{/required-permission.urn:AGL:permission::public:applications:read}}\
 185         {{#required-api}}\
 186                 {{#value=auto}}\
 187                         --ws-client=unix:%t/apis/ws/{{name}} \
 188                 {{/value=auto}}\
 189                 {{#value=ws}}\
 190                         --ws-client=unix:%t/apis/ws/{{name}} \
 191                 {{/value=ws}}\
 192                 {{#value=dbus}}\
 193                         --dbus-client={{name}} \
 194                 {{/value=dbus}}\
 195                 {{#value=link}}\
 196                         --binding=%t/apis/lib/{{name}} \
 197                 {{/value=link}}\
 198                 {{#value=cloud}}\
 199                         --cloud-client={{name}} \
 200                 {{/value=cloud}}\
 201                 {{#value=local}}\
 202                         --binding={{:#metadata.install-dir}}/{{name}} \
 203                 {{/value=local}}\
 204         {{/required-api}}\
 205         {{#provided-api}}\
 206                 {{#value=auto}}\
 207                         {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
 208                                 --ws-server=sd:{{name}} \
 209                         {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
 210                         {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 211                                 --dbus-server={{name}} \
 212                         {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 213                 {{/value=auto}}\
 214                 {{#value=ws}}\
 215                         --ws-server=sd:{{name}} \
 216                 {{/value=ws}}\
 217                 {{#value=dbus}}\
 218                         --dbus-server={{name}} \
 219                 {{/value=dbus}}\
 220         {{/provided-api}}\
 221         {{#content.type=text/html}}\
 222                 --exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t
 223         {{/content.type=text/html}}\
 224         {{#content.type=application/vnd.agl.native}}\
 225                 --exec {{:#metadata.install-dir}}/{{content.src}} @p @t
 226         {{/content.type=application/vnd.agl.native}}
 227
 228 {{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 229
 230
 231 ;---------------------------------------------------------------------------------
 232 ;----                 application/x-executable                                ----
 233 ;---------------------------------------------------------------------------------
 234 {{#content.type=application/x-executable}}
 235
 236 ExecStart={{:#metadata.install-dir}}/{{content.src}}
 237
 238 {{/content.type=application/x-executable}}
 239
 240 ;---------------------------------------------------------------------------------
 241 ; auto start
 242 ;---------------------------------------------------------------------------------
 243 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 244 %nl
 245 [Install]
 246 WantedBy=default.target
 247 %systemd-unit wanted-by default.target
 248 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 249
 250 %end systemd-unit
 251
 252
 253 ;---------------------------------------------------------------------------------
 254 ;----        P R O V I D E D   A P I S                                        ----
 255 ;---------------------------------------------------------------------------------
 256
 257 {{#provided-api}}
 258 {{#value=ws|auto}}
 259
 260 %begin systemd-unit
 261
 262 # auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
 263 #
 264 %systemd-unit user
 265 %systemd-unit socket afm-api-ws-{{name}}
 266
 267 [Socket]
 268 SmackLabel=*
 269 ListenStream=%t/apis/ws/{{name}}
 270 FileDescriptorName={{name}}
 271
 272 {{#required-permission.urn:AGL:permission::public:hidden}}\
 273 Service=afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}.service
 274 {{/required-permission.urn:AGL:permission::public:hidden}}\
 275 {{^required-permission.urn:AGL:permission::public:hidden}}\
 276 Service=afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}.service
 277 {{/required-permission.urn:AGL:permission::public:hidden}}\
 278
 279 ;---------------------------------------------------------------------------------
 280 %nl
 281 [Install]
 282 WantedBy=sockets.target
 283 %systemd-unit wanted-by sockets.target
 284 ;---------------------------------------------------------------------------------
 285
 286 %end systemd-unit
 287
 288 {{/value=ws|auto}}
 289 {{/provided-api}}
 290
 291 {{/targets}}
 292