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 #***************
  90 # use X-AFM-id={{:id}}--{{:ver}}--{{:#target}}
  91 # instead of:
  92 X-AFM-id={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
  93 # when home screen will use real ids
  94 #**************
  95 X-AFM-version={{:version}}
  96 X-AFM-author={{author.content}}
  97 X-AFM-author-email={{author.email}}
  98 X-AFM-width={{width}}
  99 X-AFM-height={{height}}
 100 {{#icon}}
 101 X-AFM-icon={{:#metadata.install-dir}}/{{:src}}
 102 {{/icon}}
 103 X-AFM--ID={{:id}}
 104 X-AFM--target-name={{:#target}}
 105 X-AFM--content={{content.src}}
 106 X-AFM--type={{content.type}}
 107 X-AFM--wgtdir={{:#metadata.install-dir}}
 108 X-AFM--workdir={{&#metadata.app-data-dir}}/{{:id}}
 109 %nl
 110
 111 Wants=sockets.target
 112
 113 # Adds check to smack
 114 ConditionSecurity=smack
 115 %nl
 116
 117 # Automatic bound to required api
 118 {{#required-api}}
 119 {{#value=auto|ws}}
 120 BindsTo=afm-api-ws-{{name}}@%i.socket
 121 After=afm-api-ws-{{name}}@%i.socket
 122 {{/value=auto|ws}}
 123 {{/required-api}}
 124 %nl
 125
 126 [Service]
 127 EnvironmentFile=-@afm_confdir@/unit.env.d/*
 128 SmackProcessLabel=User::App::{{:id}}
 129 SuccessExitStatus=0 SIGKILL
 130
 131 PAMName=su
 132 User=%i
 133 Slice=user-%i.slice
 134
 135 CapabilityBoundingSet=
 136 AmbientCapabilities=
 137
 138 {{#required-permission}}
 139   {{#urn:AGL:permission::platform:no-oom}}      OOMScoreAdjust=-500             {{/urn:AGL:permission::platform:no-oom}}
 140   {{#urn:AGL:permission::partner:real-time}}    IOSchedulingClass=realtime      {{/urn:AGL:permission::partner:real-time}}
 141 #  {{^urn:AGL:permission::partner:real-time}}    RestrictRealtime=on             {{/urn:AGL:permission::partner:real-time}}
 142   {{#urn:AGL:permission::public:display}}       SupplementaryGroups=display     {{/urn:AGL:permission::public:display}}
 143   {{^urn:AGL:permission::public:syscall:clock}} SystemCallFilter=~@clock        {{/urn:AGL:permission::public:syscall:clock}}
 144 {{/required-permission}}
 145 %nl
 146
 147 WorkingDirectory=-{{&#metadata.app-data-dir}}/{{:id}}
 148 ExecStartPre=/bin/mkdir -p {{&#metadata.app-data-dir}}/{{:id}}
 149 Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 150 Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}
 151 Environment=XDG_RUNTIME_DIR=/run/user/%i
 152 Environment=DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/%i/bus
 153
 154 ; Needed to enable debug
 155 Environment=AFM_ID={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 156 EnvironmentFile=-/var/run/afm-debug/{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}.env
 157
 158 %systemd-unit system
 159 {{#required-permission.urn:AGL:permission::public:hidden}}\
 160 %systemd-unit service afm-service-{{:id}}--{{:ver}}--{{:#target}}@
 161 {{/required-permission.urn:AGL:permission::public:hidden}}\
 162 {{^required-permission.urn:AGL:permission::public:hidden}}\
 163 %systemd-unit service afm-appli-{{:id}}--{{:ver}}--{{:#target}}@
 164 {{/required-permission.urn:AGL:permission::public:hidden}}\
 165
 166 Environment=LD_LIBRARY_PATH=$ORIGIN/lib
 167
 168 SyslogIdentifier=afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 169 StandardInput=null
 170 StandardOutput=journal
 171 StandardError=journal
 172
 173 ;---------------------------------------------------------------------------------
 174 ;----   text/html  application/vnd.agl.native  application/vnd.agl.service    ----
 175 ;---------------------------------------------------------------------------------
 176 {{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 177
 178 X-AFM--http-port={{:#metadata.http-port}}
 179
 180 ExecStart=/usr/bin/afb-daemon \
 181         --name afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}} \
 182         --rootdir={{:#metadata.install-dir}} \
 183         --workdir={{&#metadata.app-data-dir}}/{{id}} \
 184         --port={{:#metadata.http-port}} \
 185         --token=HELLO \
 186         --verbose \
 187         --monitoring \
 188         {{^content.type=application/vnd.agl.service}} \
 189                 {{#required-permission.urn:AGL:permission::public:no-htdocs}}\
 190                         --roothttp=. \
 191                 {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 192                 {{^required-permission.urn:AGL:permission::public:no-htdocs}}\
 193                         --roothttp=htdocs \
 194                 {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 195         {{/content.type=application/vnd.agl.service}} \
 196         {{#content.type=application/vnd.agl.service}} \
 197                 --roothttp=. \
 198         {{/content.type=application/vnd.agl.service}} \
 199         {{#required-permission.urn:AGL:permission::public:applications:read}}\
 200                 --alias=/icons:{{:#metadata.icons-dir}} \
 201         {{/required-permission.urn:AGL:permission::public:applications:read}}\
 202         {{#required-api}}\
 203                 {{#value=auto}}\
 204                         --ws-client=unix:%t/apis/ws/{{name}} \
 205                 {{/value=auto}}\
 206                 {{#value=ws}}\
 207                         --ws-client=unix:%t/apis/ws/{{name}} \
 208                 {{/value=ws}}\
 209                 {{#value=dbus}}\
 210                         --dbus-client={{name}} \
 211                 {{/value=dbus}}\
 212                 {{#value=link}}\
 213                         --binding=%t/apis/lib/{{name}} \
 214                 {{/value=link}}\
 215                 {{#value=cloud}}\
 216                         --cloud-client={{name}} \
 217                 {{/value=cloud}}\
 218                 {{#value=local}}\
 219                         --binding={{:#metadata.install-dir}}/{{name}} \
 220                 {{/value=local}}\
 221         {{/required-api}}\
 222         {{#provided-api}}\
 223                 {{#value=auto}}\
 224                         {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
 225                                 --ws-server=sd:{{name}} \
 226                         {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
 227                         {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 228                                 --dbus-server={{name}} \
 229                         {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 230                 {{/value=auto}}\
 231                 {{#value=ws}}\
 232                         --ws-server=sd:{{name}} \
 233                 {{/value=ws}}\
 234                 {{#value=dbus}}\
 235                         --dbus-server={{name}} \
 236                 {{/value=dbus}}\
 237         {{/provided-api}}\
 238         {{#content.type=text/html}}\
 239                 --exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t
 240         {{/content.type=text/html}}\
 241         {{#content.type=application/vnd.agl.native}}\
 242                 --exec {{:#metadata.install-dir}}/{{content.src}} @p @t
 243         {{/content.type=application/vnd.agl.native}}
 244
 245 {{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 246
 247
 248 ;---------------------------------------------------------------------------------
 249 ;----                 application/x-executable                                ----
 250 ;---------------------------------------------------------------------------------
 251 {{#content.type=application/x-executable}}
 252
 253 ExecStart={{:#metadata.install-dir}}/{{content.src}}
 254
 255 {{/content.type=application/x-executable}}
 256
 257 ;---------------------------------------------------------------------------------
 258 ; auto start
 259 ;---------------------------------------------------------------------------------
 260 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 261 %nl
 262 [Install]
 263 WantedBy=default.target
 264 %systemd-unit wanted-by default.target
 265 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 266
 267 %end systemd-unit
 268
 269
 270 ;---------------------------------------------------------------------------------
 271 ;----        P R O V I D E D   A P I S                                        ----
 272 ;---------------------------------------------------------------------------------
 273
 274 {{#provided-api}}
 275 {{#value=ws|auto}}
 276
 277 %begin systemd-unit
 278
 279 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 280 #
 281 %systemd-unit system
 282 %systemd-unit socket afm-api-ws-{{name}}@
 283
 284 [Socket]
 285 SmackLabel=*
 286 ListenStream=%t/apis/ws/{{name}}
 287 FileDescriptorName={{name}}
 288
 289 {{#required-permission.urn:AGL:permission::public:hidden}}\
 290 Service=afm-service-{{:id}}--{{:ver}}--{{:#target}}@%i.service
 291 {{/required-permission.urn:AGL:permission::public:hidden}}\
 292 {{^required-permission.urn:AGL:permission::public:hidden}}\
 293 Service=afm-appli-{{:id}}--{{:ver}}--{{:#target}}@%i.service
 294 {{/required-permission.urn:AGL:permission::public:hidden}}\
 295
 296 ;---------------------------------------------------------------------------------
 297 %nl
 298 [Install]
 299 WantedBy=sockets.target
 300 %systemd-unit wanted-by sockets.target
 301 ;---------------------------------------------------------------------------------
 302
 303 %end systemd-unit
 304
 305 {{/value=ws|auto}}
 306 {{/provided-api}}
 307
 308 {{/targets}}
 309