components/x11/x11vnc/files/x11vnc.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE service_bundle SYSTEM "/usr/share/lib/xml/dtd/service_bundle.dtd.1">
   3 <!--
   4  CDDL HEADER START
   5
   6  The contents of this file are subject to the terms of the
   7  Common Development and Distribution License (the "License").
   8  You may not use this file except in compliance with the License.
   9
  10  You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  11  or http://www.opensolaris.org/os/licensing.
  12  See the License for the specific language governing permissions
  13  and limitations under the License.
  14
  15  When distributing Covered Code, include this CDDL HEADER in each
  16  file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  17  If applicable, add the following below this CDDL HEADER, with the
  18  fields enclosed by brackets "[]" replaced with your own identifying
  19  information: Portions Copyright [yyyy] [name of copyright owner]
  20
  21  CDDL HEADER END
  22
  23         NOTE:  This service manifest is not editable; its contents will
  24         be overwritten by package or patch operations, including
  25         operating system upgrade.  Make customizations in a different
  26         file.
  27
  28         Service manifest for the x11vnc server to provide remote access
  29         to persistent GUI sessions, such as a system DISPLAY=:0 with its
  30         currently rendered lightdm login or interactive user session.
  31 -->
  32 <!--
  33         Copyright 2022 Jim Klimov
  34 -->
  35 <service_bundle type='manifest' name='x11vnc'>
  36
  37         <service name='application/x11/x11vnc' type='service' version='1'>
  38
  39                 <dependency
  40                         name='filesystem'
  41                         grouping='require_all'
  42                         restart_on='none'
  43                         type='service'>
  44                                 <service_fmri value='svc:/system/filesystem/local'/>
  45                 </dependency>
  46
  47                 <dependency name='multi-user'
  48                         grouping='require_all'
  49                         restart_on='error'
  50                         type='service'>
  51                                 <service_fmri value='svc:/milestone/multi-user:default'/>
  52                 </dependency>
  53
  54                 <dependency
  55                         name='sysconfig'
  56                         grouping='require_all'
  57                         restart_on='none'
  58                         type='service'>
  59                                 <service_fmri value='svc:/milestone/sysconfig'/>
  60                 </dependency>
  61
  62                 <dependency
  63                         name='lightdm'
  64                         grouping='optional_all'
  65                         restart_on='refresh'
  66                         type='service'>
  67                                 <service_fmri value='svc:/application/graphical-login/lightdm:default'/>
  68                 </dependency>
  69
  70                 <dependency
  71                         name='utmpx'
  72                         grouping='require_all'
  73                         restart_on='none'
  74                         type='service'>
  75                                 <service_fmri value='svc:/system/utmp'/>
  76                 </dependency>
  77
  78                 <dependency
  79                         name='x11-init'
  80                         grouping='require_all'
  81                         restart_on='none'
  82                         type='service'>
  83                                 <service_fmri value='svc:/application/x11/x11-init'/>
  84                 </dependency>
  85
  86                 <exec_method type='method' name='start'
  87                         exec='/lib/svc/method/svc-x11vnc start' timeout_seconds='60'>
  88                 </exec_method>
  89
  90                 <exec_method type='method' name='stop'
  91                         exec=':kill' timeout_seconds='60'>
  92                 </exec_method>
  93
  94                 <exec_method type='method' name='refresh'
  95                         exec=':kill' timeout_seconds='60'>
  96                 </exec_method>
  97
  98                 <!-- Authorization -->
  99                 <property_group name='general' type='framework'>
 100                         <!-- to start stop x11vnc, same as for lightdm: -->
 101                         <propval name='action_authorization' type='astring'
 102                                         value='solaris.smf.manage.dt.login' />
 103                 </property_group>
 104
 105                 <property_group name='startd' type='framework'>
 106                         <!-- Track the started process until it exits -->
 107                         <propval name='duration' type='astring'
 108                                 value='child' />
 109                         <!-- Keep restarting as long as it is enabled -->
 110                         <propval name='ignore_error' type='astring'
 111                                 value='core,signal' />
 112                 </property_group>
 113
 114                 <!-- Properties below may be defined at service or instance
 115                      level; note that not-empty strings and positive numbers
 116                      at the particular instance's level would have complete
 117                      precedence over service-level "general defaults":
 118                   -->
 119                 <property_group name='x11vnc' type='application'>
 120                         <propval name='PERMISSION_MODEL' type='astring' value='lightdm' />
 121                         <propval name='ARGS' type='astring' value='' />
 122                         <propval name='BASE_PORT' type='integer' value='-1' />
 123                 </property_group>
 124
 125                 <!-- Service instance name conveys the display number
 126                      (and per SMF syntax, may not be just a number):
 127                   -->
 128                 <instance name='display-0' enabled='false' >
 129
 130                         <!-- these are passed to x11vnc in the method script -->
 131                         <property_group name='x11vnc' type='application'>
 132                                 <propval name='PERMISSION_MODEL' type='astring' value='lightdm' />
 133                                 <!-- The daemon suggests a lot of custom configuration
 134                                      for security, protocol aspects, etc. in the log
 135                                      (consider listening on localhost and SSH tunnels,
 136                                      and enabling software compositing in MATE if
 137                                      window-dragging lags awfully, especially in VMs).
 138                                      Note that if an X11 session gets logged in and
 139                                      later disconnected, and that user account has a
 140                                      ~/.vnc/passwd file, that one would be honored by
 141                                      the method script when reconnecting the VNC again.
 142                                   -->
 143                                 <propval name='ARGS' type='astring' value='' />
 144                                 <!-- Normally values below are defaulted by the method
 145                                      script or guessed from SMF instance name; however
 146                                      in some setups it can make sense to override them:
 147                                   -->
 148                                 <propval name='DISPLAY_NUMBER' type='integer' value='-1' />
 149                                 <propval name='BASE_PORT' type='integer' value='-1' />
 150                                 <propval name='PORT' type='integer' value='-1' />
 151                         </property_group>
 152
 153                 </instance>
 154
 155                 <template>
 156                         <common_name>
 157                                 <loctext xml:lang='C'>
 158                                         X11VNC Remote desktop service
 159                                 </loctext>
 160                         </common_name>
 161                         <description>
 162                                 <loctext xml:lang='C'>
 163                                         X11VNC Remote desktop service
 164                                 </loctext>
 165                         </description>
 166                         <documentation>
 167                                 <manpage title='x11vnc' section='1'
 168                                         manpath='/usr/share/man'/>
 169                         </documentation>
 170                 </template>
 171         </service>
 172
 173 </service_bundle>