From f055527735e86f5ec280d08945b56cfd08e35959 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Mon, 11 Jan 2021 11:52:14 +0100 Subject: [PATCH 1/6] Import evilham's jitsi types as-it --- .../prometheus-jitsi-meet-explorer-version | 7 + .../files/debconf_settings.sh | 56 ++ type/__evilham_jitsi_meet/files/ufw | 10 + type/__evilham_jitsi_meet/gencode-remote | 5 + type/__evilham_jitsi_meet/man.rst | 84 +++ type/__evilham_jitsi_meet/manifest | 197 +++++ type/__evilham_jitsi_meet/parameter/boolean | 1 + .../parameter/default/turn-server | 0 type/__evilham_jitsi_meet/parameter/optional | 2 + type/__evilham_jitsi_meet/singleton | 0 .../files/config.js.sh | 700 ++++++++++++++++++ .../files/config.js.sh.orig | 694 +++++++++++++++++ .../files/nginx.sh | 156 ++++ .../files/nginx.sh.orig | 139 ++++ .../gencode-remote | 5 + type/__evilham_jitsi_meet_domain/man.rst | 151 ++++ type/__evilham_jitsi_meet_domain/manifest | 88 +++ .../parameter/boolean | 2 + .../parameter/default/branding-index | 0 .../parameter/default/branding-json | 0 .../parameter/default/branding-watermark | 0 .../parameter/default/channel-last-n | 1 + .../parameter/default/default-language | 1 + .../parameter/default/notice-message | 0 .../parameter/default/start-video-muted | 1 + .../parameter/default/turn-server | 0 .../parameter/default/video-constraints | 0 .../parameter/optional | 9 + .../parameter/required | 1 + 29 files changed, 2310 insertions(+) create mode 100755 type/__evilham_jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version create mode 100644 type/__evilham_jitsi_meet/files/debconf_settings.sh create mode 100644 type/__evilham_jitsi_meet/files/ufw create mode 100755 type/__evilham_jitsi_meet/gencode-remote create mode 100644 type/__evilham_jitsi_meet/man.rst create mode 100755 type/__evilham_jitsi_meet/manifest create mode 100644 type/__evilham_jitsi_meet/parameter/boolean create mode 100644 type/__evilham_jitsi_meet/parameter/default/turn-server create mode 100644 type/__evilham_jitsi_meet/parameter/optional create mode 100644 type/__evilham_jitsi_meet/singleton create mode 100644 type/__evilham_jitsi_meet_domain/files/config.js.sh create mode 100644 type/__evilham_jitsi_meet_domain/files/config.js.sh.orig create mode 100644 type/__evilham_jitsi_meet_domain/files/nginx.sh create mode 100644 type/__evilham_jitsi_meet_domain/files/nginx.sh.orig create mode 100755 type/__evilham_jitsi_meet_domain/gencode-remote create mode 100644 type/__evilham_jitsi_meet_domain/man.rst create mode 100755 type/__evilham_jitsi_meet_domain/manifest create mode 100644 type/__evilham_jitsi_meet_domain/parameter/boolean create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/branding-index create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/branding-json create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/branding-watermark create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/channel-last-n create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/default-language create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/notice-message create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/start-video-muted create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/turn-server create mode 100644 type/__evilham_jitsi_meet_domain/parameter/default/video-constraints create mode 100644 type/__evilham_jitsi_meet_domain/parameter/optional create mode 100644 type/__evilham_jitsi_meet_domain/parameter/required diff --git a/type/__evilham_jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version b/type/__evilham_jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version new file mode 100755 index 0000000..b1cec48 --- /dev/null +++ b/type/__evilham_jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version @@ -0,0 +1,7 @@ +#!/bin/sh -e + +EXPORTER_VERSION_FILE="/usr/local/bin/.prometheus-jitsi-meet-exporter.cdist.version" + +if [ -f "${EXPORTER_VERSION_FILE}" ]; then + cat "${EXPORTER_VERSION_FILE}" +fi diff --git a/type/__evilham_jitsi_meet/files/debconf_settings.sh b/type/__evilham_jitsi_meet/files/debconf_settings.sh new file mode 100644 index 0000000..9e358f0 --- /dev/null +++ b/type/__evilham_jitsi_meet/files/debconf_settings.sh @@ -0,0 +1,56 @@ +#!/bin/sh -e + +# This can be obtained with debconf-get-selections on a host with jitsi +# (and also analysing the deb-src) +if false; then + # We are currently not using these, just here as documentation + DEBCONF_SETTINGS="$(cat < + + +COPYING +------- +Copyright \(C) 2020 Evilham. diff --git a/type/__evilham_jitsi_meet/manifest b/type/__evilham_jitsi_meet/manifest new file mode 100755 index 0000000..83d9dab --- /dev/null +++ b/type/__evilham_jitsi_meet/manifest @@ -0,0 +1,197 @@ +#!/bin/sh -e + +os="$(cat "${__global}/explorer/os")" +init="$(cat "${__global}/explorer/init")" +case "${os}" in + devuan|debian) + ;; + *) + echo "Your OS '${os}' is currently not supported." > /dev/stderr + exit 1 + ;; +esac + + +JITSI_HOST="${__target_host}" +TURN_SERVER="$(cat "${__object}/parameter/turn-server")" +TURN_SECRET="$(cat "${__object}/parameter/turn-secret")" + +if [ -z "${TURN_SERVER}" ]; then + TURN_SERVER="${JITSI_HOST}" +fi + +PROMETHEUS_JITSI_EXPORTER_IS_VERSION="$(cat "${__object}/explorer/prometheus-jitsi-meet-explorer-version")" + +# The rest is loosely based on Jitsi's documentation +# https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart + +# Setup repositories +## First the signing keys +__package gnupg2 +require="__package/gnupg2" __apt_key_uri jitsi_meet \ + --name 'Jitsi ' \ + --uri https://download.jitsi.org/jitsi-key.gpg.key \ + --state present +## Now the repositories (they are a tad weird, so distribution is 'stable/') +require="__ufw __apt_key_uri/jitsi_meet" __apt_source jitsi_meet \ + --uri 'https://download.jitsi.org' \ + --distribution 'stable/' \ + --state present +## Ensure apt cache is up-to-date +require="__apt_source/jitsi_meet" __apt_update_index + +export require="${require} __apt_source/jitsi_meet __apt_update_index" + +# Pre-feed debconf settings, so Jitsi's installation has a good config +. "${__type}/files/debconf_settings.sh" # This defines DEBCONF_SETTINGS +__debconf_set_selections jitsi_meet --file - <&1 +EOF + + export require="__evilham_runit_service/prometheus-jitsi-meet-exporter" + JITSI_MEET_EXPORTER_SERVICE="sv %s prometheus-jitsi-meet-exporter" + ;; + systemd) + __systemd_unit prometheus-jitsi-meet-exporter.service \ + --source "-" \ + --enablement-state "enabled" <${JITSI_HOST}' + }, + + // BOSH URL. FIXME: use XEP-0156 to discover it. + bosh: '//${JITSI_HOST}/http-bind', + + // Websocket URL + // websocket: 'wss://${JITSI_HOST}/xmpp-websocket', + + // The name of client node advertised in XEP-0115 'c' stanza + clientNode: 'http://jitsi.org/jitsimeet', + + // The real JID of focus participant - can be overridden here + // Do not change username - FIXME: Make focus username configurable + // https://github.com/jitsi/jitsi-meet/issues/7376 + // focusUserJid: 'focus@auth.${JITSI_HOST}', + + + // Testing / experimental features. + // + + testing: { + // Disables the End to End Encryption feature. Useful for debugging + // issues related to insertable streams. + // disableE2EE: false, + + // P2P test mode disables automatic switching to P2P when there are 2 + // participants in the conference. + p2pTestMode: false + + // Enables the test specific features consumed by jitsi-meet-torture + // testMode: false + + // Disables the auto-play behavior of *all* newly created video element. + // This is useful when the client runs on a host with limited resources. + // noAutoPlayVideo: false + + // Enable / disable 500 Kbps bitrate cap on desktop tracks. When enabled, + // simulcast is turned off for the desktop share. If presenter is turned + // on while screensharing is in progress, the max bitrate is automatically + // adjusted to 2.5 Mbps. This takes a value between 0 and 1 which determines + // the probability for this to be enabled. + // capScreenshareBitrate: 1 // 0 to disable + + // Enable callstats only for a percentage of users. + // This takes a value between 0 and 100 which determines the probability for + // the callstats to be enabled. + // callStatsThreshold: 5 // enable callstats for 5% of the users. + }, + + // Disables ICE/UDP by filtering out local and remote UDP candidates in + // signalling. + // webrtcIceUdpDisable: false, + + // Disables ICE/TCP by filtering out local and remote TCP candidates in + // signalling. + // webrtcIceTcpDisable: false, + + + // Media + // + + // Audio + + // Disable measuring of audio levels. + disableAudioLevels: $(if [ -n "${DISABLE_AUDIO_LEVELS}" ]; then printf "true"; else printf "false"; fi), + // audioLevelsInterval: 200, + + // Enabling this will run the lib-jitsi-meet no audio detection module which + // will notify the user if the current selected microphone has no audio + // input and will suggest another valid device if one is present. + enableNoAudioDetection: true, + + // Enabling this will run the lib-jitsi-meet noise detection module which will + // notify the user if there is noise, other than voice, coming from the current + // selected microphone. The purpose it to let the user know that the input could + // be potentially unpleasant for other meeting participants. + enableNoisyMicDetection: true, + + // Start the conference in audio only mode (no video is being received nor + // sent). + // startAudioOnly: false, + + // Every participant after the Nth will start audio muted. + // startAudioMuted: 10, + + // Start calls with audio muted. Unlike the option above, this one is only + // applied locally. FIXME: having these 2 options is confusing. + // startWithAudioMuted: false, + + // Enabling it (with #params) will disable local audio output of remote + // participants and to enable it back a reload is needed. + // startSilent: false + + // Sets the preferred target bitrate for the Opus audio codec by setting its + // 'maxaveragebitrate' parameter. Currently not available in p2p mode. + // Valid values are in the range 6000 to 510000 + // opusMaxAverageBitrate: 20000, + + // Enables redundancy for Opus + // enableOpusRed: false + + // Video + + // Sets the preferred resolution (height) for local video. Defaults to 720. + // resolution: 720, + + // How many participants while in the tile view mode, before the receiving video quality is reduced from HD to SD. + // Use -1 to disable. + // maxFullResolutionParticipants: 2, + + // w3c spec-compliant video constraints to use for video capture. Currently + // used by browsers that return true from lib-jitsi-meet's + // util#browser#usesNewGumFlow. The constraints are independent from + // this config's resolution value. Defaults to requesting an ideal + // resolution of 720p. + // constraints: { + // video: { + // height: { + // ideal: 720, + // max: 720, + // min: 240 + // } + // } + // }, +$(if [ -n "${VIDEO_CONSTRAINTS}" ]; then echo "${VIDEO_CONSTRAINTS},"; fi) + + // Enable / disable simulcast support. + // disableSimulcast: false, + + // Enable / disable layer suspension. If enabled, endpoints whose HD + // layers are not in use will be suspended (no longer sent) until they + // are requested again. + // enableLayerSuspension: false, + + // Every participant after the Nth will start video muted. + startVideoMuted: ${START_VIDEO_MUTED}, + + // Start calls with video muted. Unlike the option above, this one is only + // applied locally. FIXME: having these 2 options is confusing. + // startWithVideoMuted: false, + + // If set to true, prefer to use the H.264 video codec (if supported). + // Note that it's not recommended to do this because simulcast is not + // supported when using H.264. For 1-to-1 calls this setting is enabled by + // default and can be toggled in the p2p section. + // This option has been deprecated, use preferredCodec under videoQuality section instead. + // preferH264: true, + + // If set to true, disable H.264 video codec by stripping it out of the + // SDP. + // disableH264: false, + + // Desktop sharing + + // Optional desktop sharing frame rate options. Default value: min:5, max:5. + // desktopSharingFrameRate: { + // min: 5, + // max: 5 + // }, + + // Try to start calls with screen-sharing instead of camera video. + // startScreenSharing: false, + + // Recording + + // Whether to enable file recording or not. + // fileRecordingsEnabled: false, + // Enable the dropbox integration. + // dropbox: { + // appKey: '' // Specify your app key here. + // // A URL to redirect the user to, after authenticating + // // by default uses: + // // 'https://${JITSI_HOST}/static/oauth.html' + // redirectURI: + // 'https://${JITSI_HOST}/subfolder/static/oauth.html' + // }, + // When integrations like dropbox are enabled only that will be shown, + // by enabling fileRecordingsServiceEnabled, we show both the integrations + // and the generic recording service (its configuration and storage type + // depends on jibri configuration) + // fileRecordingsServiceEnabled: false, + // Whether to show the possibility to share file recording with other people + // (e.g. meeting participants), based on the actual implementation + // on the backend. + // fileRecordingsServiceSharingEnabled: false, + + // Whether to enable live streaming or not. + // liveStreamingEnabled: false, + + // Transcription (in interface_config, + // subtitles and buttons can be configured) + // transcribingEnabled: false, + + // Enables automatic turning on captions when recording is started + // autoCaptionOnRecord: false, + + // Misc + + // Default value for the channel "last N" attribute. -1 for unlimited. + channelLastN: ${CHANNEL_LAST_N}, + + // Provides a way to use different "last N" values based on the number of participants in the conference. + // The keys in an Object represent number of participants and the values are "last N" to be used when number of + // participants gets to or above the number. + // + // For the given example mapping, "last N" will be set to 20 as long as there are at least 5, but less than + // 29 participants in the call and it will be lowered to 15 when the 30th participant joins. The 'channelLastN' + // will be used as default until the first threshold is reached. + // + // lastNLimits: { + // 5: 20, + // 30: 15, + // 50: 10, + // 70: 5, + // 90: 2 + // }, + + // Specify the settings for video quality optimizations on the client. + // videoQuality: { + // // Provides a way to prevent a video codec from being negotiated on the JVB connection. The codec specified + // // here will be removed from the list of codecs present in the SDP answer generated by the client. If the + // // same codec is specified for both the disabled and preferred option, the disable settings will prevail. + // // Note that 'VP8' cannot be disabled since it's a mandatory codec, the setting will be ignored in this case. + // disabledCodec: 'H264', + // + // // Provides a way to set a preferred video codec for the JVB connection. If 'H264' is specified here, + // // simulcast will be automatically disabled since JVB doesn't support H264 simulcast yet. This will only + // // rearrange the the preference order of the codecs in the SDP answer generated by the browser only if the + // // preferred codec specified here is present. Please ensure that the JVB offers the specified codec for this + // // to take effect. + // preferredCodec: 'VP8', + // + // // Provides a way to configure the maximum bitrates that will be enforced on the simulcast streams for + // // video tracks. The keys in the object represent the type of the stream (LD, SD or HD) and the values + // // are the max.bitrates to be set on that particular type of stream. The actual send may vary based on + // // the available bandwidth calculated by the browser, but it will be capped by the values specified here. + // // This is currently not implemented on app based clients on mobile. + // maxBitratesVideo: { + // low: 200000, + // standard: 500000, + // high: 1500000 + // }, + // + // // The options can be used to override default thresholds of video thumbnail heights corresponding to + // // the video quality levels used in the application. At the time of this writing the allowed levels are: + // // 'low' - for the low quality level (180p at the time of this writing) + // // 'standard' - for the medium quality level (360p) + // // 'high' - for the high quality level (720p) + // // The keys should be positive numbers which represent the minimal thumbnail height for the quality level. + // // + // // With the default config value below the application will use 'low' quality until the thumbnails are + // // at least 360 pixels tall. If the thumbnail height reaches 720 pixels then the application will switch to + // // the high quality. + // minHeightForQualityLvl: { + // 360: 'standard, + // 720: 'high' + // } + // }, + + // // Options for the recording limit notification. + // recordingLimit: { + // + // // The recording limit in minutes. Note: This number appears in the notification text + // // but doesn't enforce the actual recording time limit. This should be configured in + // // jibri! + // limit: 60, + // + // // The name of the app with unlimited recordings. + // appName: 'Unlimited recordings APP', + // + // // The URL of the app with unlimited recordings. + // appURL: 'https://unlimited.recordings.app.com/' + // }, + + // Disables or enables RTX (RFC 4588) (defaults to false). + // disableRtx: false, + + // Disables or enables TCC (the default is in Jicofo and set to true) + // (draft-holmer-rmcat-transport-wide-cc-extensions-01). This setting + // affects congestion control, it practically enables send-side bandwidth + // estimations. + // enableTcc: true, + + // Disables or enables REMB (the default is in Jicofo and set to false) + // (draft-alvestrand-rmcat-remb-03). This setting affects congestion + // control, it practically enables recv-side bandwidth estimations. When + // both TCC and REMB are enabled, TCC takes precedence. When both are + // disabled, then bandwidth estimations are disabled. + // enableRemb: false, + + // Enables ICE restart logic in LJM and displays the page reload overlay on + // ICE failure. Current disabled by default because it's causing issues with + // signaling when Octo is enabled. Also when we do an "ICE restart"(which is + // not a real ICE restart), the client maintains the TCC sequence number + // counter, but the bridge resets it. The bridge sends media packets with + // TCC sequence numbers starting from 0. + // enableIceRestart: false, + + // Defines the minimum number of participants to start a call (the default + // is set in Jicofo and set to 2). + // minParticipants: 2, + + // Use TURN/UDP servers for the jitsi-videobridge connection (by default + // we filter out TURN/UDP because it is usually not needed since the + // bridge itself is reachable via UDP) + // useTurnUdp: false + + // Enables / disables a data communication channel with the Videobridge. + // Values can be 'datachannel', 'websocket', true (treat it as + // 'datachannel'), undefined (treat it as 'datachannel') and false (don't + // open any channel). + // openBridgeChannel: true, + openBridgeChannel: 'websocket', + + + // UI + // + + // Hides lobby button + // hideLobbyButton: false, + + // Require users to always specify a display name. + // requireDisplayName: true, + + // Whether to use a welcome page or not. In case it's false a random room + // will be joined when no room is specified. + enableWelcomePage: true, + + // Enabling the close page will ignore the welcome page redirection when + // a call is hangup. + // enableClosePage: false, + + // Disable hiding of remote thumbnails when in a 1-on-1 conference call. + // disable1On1Mode: false, + + // Default language for the user interface. + defaultLanguage: '${DEFAULT_LANGUAGE}', + + // If true all users without a token will be considered guests and all users + // with token will be considered non-guests. Only guests will be allowed to + // edit their profile. + enableUserRolesBasedOnToken: false, + + // Whether or not some features are checked based on token. + // enableFeaturesBasedOnToken: false, + + // Enable lock room for all moderators, even when userRolesBasedOnToken is enabled and participants are guests. + // lockRoomGuestEnabled: false, + + // When enabled the password used for locking a room is restricted to up to the number of digits specified + // roomPasswordNumberOfDigits: 10, + // default: roomPasswordNumberOfDigits: false, + + // Message to show the users. Example: 'The service will be down for + // maintenance at 01:00 AM GMT, + noticeMessage: '${NOTICE_MESSAGE}', + + // Enables calendar integration, depends on googleApiApplicationClientID + // and microsoftApiApplicationClientID + // enableCalendarIntegration: false, + + // When 'true', it shows an intermediate page before joining, where the user can configure their devices. + // prejoinPageEnabled: false, + + // If true, shows the unsafe room name warning label when a room name is + // deemed unsafe (due to the simplicity in the name) and a password is not + // set or the lobby is not enabled. + // enableInsecureRoomNameWarning: false, + + // Whether to automatically copy invitation URL after creating a room. + // Document should be focused for this option to work + // enableAutomaticUrlCopy: false, + + // Stats + // + + // Whether to enable stats collection or not in the TraceablePeerConnection. + // This can be useful for debugging purposes (post-processing/analysis of + // the webrtc stats) as it is done in the jitsi-meet-torture bandwidth + // estimation tests. + // gatherStats: false, + + // The interval at which PeerConnection.getStats() is called. Defaults to 10000 + // pcStatsInterval: 10000, + + // To enable sending statistics to callstats.io you must provide the + // Application ID and Secret. + // callStatsID: '', + // callStatsSecret: '', + + // Enables sending participants' display names to callstats + // enableDisplayNameInStats: false, + + // Enables sending participants' emails (if available) to callstats and other analytics + // enableEmailInStats: false, + + // Privacy + // + + // If third party requests are disabled, no other server will be contacted. + // This means avatars will be locally generated and callstats integration + // will not function. + disableThirdPartyRequests: $(if [ -z "${ENABLE_THIRD_PARTY_REQUESTS}" ]; then printf "true"; else printf "false"; fi), + + + // Peer-To-Peer mode: used (if enabled) when there are just 2 participants. + // + + p2p: { + // Enables peer to peer mode. When enabled the system will try to + // establish a direct connection when there are exactly 2 participants + // in the room. If that succeeds the conference will stop sending data + // through the JVB and use the peer to peer connection instead. When a + // 3rd participant joins the conference will be moved back to the JVB + // connection. + enabled: true, + + // The STUN servers that will be used in the peer to peer connections + stunServers: [ + + { urls: 'stun:${TURN_SERVER}:443' } + ] + + // Sets the ICE transport policy for the p2p connection. At the time + // of this writing the list of possible values are 'all' and 'relay', + // but that is subject to change in the future. The enum is defined in + // the WebRTC standard: + // https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum. + // If not set, the effective value is 'all'. + // iceTransportPolicy: 'all', + + // If set to true, it will prefer to use H.264 for P2P calls (if H.264 + // is supported). This setting is deprecated, use preferredCodec instead. + // preferH264: true + + // Provides a way to set the video codec preference on the p2p connection. Acceptable + // codec values are 'VP8', 'VP9' and 'H264'. + // preferredCodec: 'H264', + + // If set to true, disable H.264 video codec by stripping it out of the + // SDP. This setting is deprecated, use disabledCodec instead. + // disableH264: false, + + // Provides a way to prevent a video codec from being negotiated on the p2p connection. + // disabledCodec: '', + + // How long we're going to wait, before going back to P2P after the 3rd + // participant has left the conference (to filter out page reload). + // backToP2PDelay: 5 + }, + + analytics: { + // The Google Analytics Tracking ID: + // googleAnalyticsTrackingId: 'your-tracking-id-UA-123456-1' + + // Matomo configuration: + // matomoEndpoint: 'https://your-matomo-endpoint/', + // matomoSiteID: '42', + + // The Amplitude APP Key: + // amplitudeAPPKey: '' + + // Configuration for the rtcstats server: + // By enabling rtcstats server every time a conference is joined the rtcstats + // module connects to the provided rtcstatsEndpoint and sends statistics regarding + // PeerConnection states along with getStats metrics polled at the specified + // interval. + // rtcstatsEnabled: true, + + // In order to enable rtcstats one needs to provide a endpoint url. + // rtcstatsEndpoint: wss://rtcstats-server-pilot.jitsi.net/, + + // The interval at which rtcstats will poll getStats, defaults to 1000ms. + // If the value is set to 0 getStats won't be polled and the rtcstats client + // will only send data related to RTCPeerConnection events. + // rtcstatsPolIInterval: 1000 + + // Array of script URLs to load as lib-jitsi-meet "analytics handlers". + // scriptURLs: [ + // "libs/analytics-ga.min.js", // google-analytics + // "https://example.com/my-custom-analytics.js" + // ], + }, + + // Logs that should go be passed through the 'log' event if a handler is defined for it + // apiLogLevels: ['warn', 'log', 'error', 'info', 'debug'], + + // Information about the jitsi-meet instance we are connecting to, including + // the user region as seen by the server. + deploymentInfo: { + // shard: "shard1", + // region: "europe", + // userRegion: "asia" + }, + + // Decides whether the start/stop recording audio notifications should play on record. + // disableRecordAudioNotification: false, + + // Information for the chrome extension banner + // chromeExtensionBanner: { + // // The chrome extension to be installed address + // url: 'https://chrome.google.com/webstore/detail/jitsi-meetings/kglhbbefdnlheedjiejgomgmfplipfeb', + + // // Extensions info which allows checking if they are installed or not + // chromeExtensionsInfo: [ + // { + // id: 'kglhbbefdnlheedjiejgomgmfplipfeb', + // path: 'jitsi-logo-48x48.png' + // } + // ] + // }, + + // Local Recording + // + + // localRecording: { + // Enables local recording. + // Additionally, 'localrecording' (all lowercase) needs to be added to + // TOOLBAR_BUTTONS in interface_config.js for the Local Recording + // button to show up on the toolbar. + // + // enabled: true, + // + + // The recording format, can be one of 'ogg', 'flac' or 'wav'. + // format: 'flac' + // + + // }, + + // Options related to end-to-end (participant to participant) ping. + // e2eping: { + // // The interval in milliseconds at which pings will be sent. + // // Defaults to 10000, set to <= 0 to disable. + // pingInterval: 10000, + // + // // The interval in milliseconds at which analytics events + // // with the measured RTT will be sent. Defaults to 60000, set + // // to <= 0 to disable. + // analyticsInterval: 60000, + // }, + + // If set, will attempt to use the provided video input device label when + // triggering a screenshare, instead of proceeding through the normal flow + // for obtaining a desktop stream. + // NOTE: This option is experimental and is currently intended for internal + // use only. + // _desktopSharingSourceDevice: 'sample-id-or-label', + + // If true, any checks to handoff to another application will be prevented + // and instead the app will continue to display in the current browser. + // disableDeepLinking: false, + + // A property to disable the right click context menu for localVideo + // the menu has option to flip the locally seen video for local presentations + // disableLocalVideoFlip: false, + + // Mainly privacy related settings + + // Disables all invite functions from the app (share, invite, dial out...etc) + // disableInviteFunctions: true, + + // Disables storing the room name to the recents list + // doNotStoreRoom: true, + + // Deployment specific URLs. + // deploymentUrls: { + // // If specified a 'Help' button will be displayed in the overflow menu with a link to the specified URL for + // // user documentation. + // userDocumentationURL: 'https://docs.example.com/video-meetings.html', + // // If specified a 'Download our apps' button will be displayed in the overflow menu with a link + // // to the specified URL for an app download page. + // downloadAppsUrl: 'https://docs.example.com/our-apps.html' + // }, + + // Options related to the remote participant menu. + // remoteVideoMenu: { + // // If set to true the 'Kick out' button will be disabled. + // disableKick: true + // }, + + // If set to true all muting operations of remote participants will be disabled. + // disableRemoteMute: true, + + /** + External API url used to receive branding specific information. + If there is no url set or there are missing fields, the defaults are applied. + None of the fields are mandatory and the response must have the shape: + { + // The hex value for the colour used as background + backgroundColor: '#fff', + // The url for the image used as background + backgroundImageUrl: 'https://example.com/background-img.png', + // The anchor url used when clicking the logo image + logoClickUrl: 'https://example-company.org', + // The url used for the image used as logo + logoImageUrl: 'https://example.com/logo-img.png' + } + */ + brandingDataUrl: "$(if [ -n "${BRANDING_JSON}" ]; then printf "/branding.json"; fi)", + + // The URL of the moderated rooms microservice, if available. If it + // is present, a link to the service will be rendered on the welcome page, + // otherwise the app doesn't render it. + // moderatedRoomServiceUrl: 'https://moderated.${JITSI_HOST}', + + // List of undocumented settings used in jitsi-meet + /** + _immediateReloadThreshold + debug + debugAudioLevels + deploymentInfo + dialInConfCodeUrl + dialInNumbersUrl + dialOutAuthUrl + dialOutCodesUrl + disableRemoteControl + displayJids + etherpad_base + externalConnectUrl + firefox_fake_device + googleApiApplicationClientID + iAmRecorder + iAmSipGateway + microsoftApiApplicationClientID + peopleSearchQueryTypes + peopleSearchUrl + requireDisplayName + tokenAuthUrl + */ + + /** + * This property can be used to alter the generated meeting invite links (in combination with a branding domain + * which is retrieved internally by jitsi meet) (e.g. https://meet.jit.si/someMeeting + * can become https://brandedDomain/roomAlias) + */ + // brandingRoomAlias: null, + + // List of undocumented settings used in lib-jitsi-meet + /** + _peerConnStatusOutOfLastNTimeout + _peerConnStatusRtcMuteTimeout + abTesting + avgRtpStatsN + callStatsConfIDNamespace + callStatsCustomScriptUrl + desktopSharingSources + disableAEC + disableAGC + disableAP + disableHPF + disableNS + enableLipSync + enableTalkWhileMuted + forceJVB121Ratio + hiddenDomain + ignoreStartMuted + nick + startBitrate + */ + + + // Allow all above example options to include a trailing comma and + // prevent fear when commenting out the last value. + makeJsonParserHappy: 'even if last key had a trailing comma' + + // no configuration value should follow this line. +}; + +/* eslint-enable no-unused-vars, no-var */ +EOF +)" diff --git a/type/__evilham_jitsi_meet_domain/files/config.js.sh.orig b/type/__evilham_jitsi_meet_domain/files/config.js.sh.orig new file mode 100644 index 0000000..da2bff5 --- /dev/null +++ b/type/__evilham_jitsi_meet_domain/files/config.js.sh.orig @@ -0,0 +1,694 @@ +/* eslint-disable no-unused-vars, no-var */ + +var config = { + // Connection + // + + hosts: { + // XMPP domain. + domain: 'jitsi-meet.example.org', + + // When using authentication, domain for guest users. + // anonymousdomain: 'guest.example.com', + + // Domain for authenticated users. Defaults to . + // authdomain: 'jitsi-meet.example.org', + + // Call control component (Jigasi). + // call_control: 'callcontrol.jitsi-meet.example.org', + + // Focus component domain. Defaults to focus.. + // focus: 'focus.jitsi-meet.example.org', + + // XMPP MUC domain. FIXME: use XEP-0030 to discover it. + muc: 'conference.jitsi-meet.example.org' + }, + + // BOSH URL. FIXME: use XEP-0156 to discover it. + bosh: '//jitsi-meet.example.org/http-bind', + + // Websocket URL + // websocket: 'wss://jitsi-meet.example.org/xmpp-websocket', + + // The name of client node advertised in XEP-0115 'c' stanza + clientNode: 'http://jitsi.org/jitsimeet', + + // The real JID of focus participant - can be overridden here + // Do not change username - FIXME: Make focus username configurable + // https://github.com/jitsi/jitsi-meet/issues/7376 + // focusUserJid: 'focus@auth.jitsi-meet.example.org', + + + // Testing / experimental features. + // + + testing: { + // Disables the End to End Encryption feature. Useful for debugging + // issues related to insertable streams. + // disableE2EE: false, + + // P2P test mode disables automatic switching to P2P when there are 2 + // participants in the conference. + p2pTestMode: false + + // Enables the test specific features consumed by jitsi-meet-torture + // testMode: false + + // Disables the auto-play behavior of *all* newly created video element. + // This is useful when the client runs on a host with limited resources. + // noAutoPlayVideo: false + + // Enable / disable 500 Kbps bitrate cap on desktop tracks. When enabled, + // simulcast is turned off for the desktop share. If presenter is turned + // on while screensharing is in progress, the max bitrate is automatically + // adjusted to 2.5 Mbps. This takes a value between 0 and 1 which determines + // the probability for this to be enabled. + // capScreenshareBitrate: 1 // 0 to disable + + // Enable callstats only for a percentage of users. + // This takes a value between 0 and 100 which determines the probability for + // the callstats to be enabled. + // callStatsThreshold: 5 // enable callstats for 5% of the users. + }, + + // Disables ICE/UDP by filtering out local and remote UDP candidates in + // signalling. + // webrtcIceUdpDisable: false, + + // Disables ICE/TCP by filtering out local and remote TCP candidates in + // signalling. + // webrtcIceTcpDisable: false, + + + // Media + // + + // Audio + + // Disable measuring of audio levels. + // disableAudioLevels: false, + // audioLevelsInterval: 200, + + // Enabling this will run the lib-jitsi-meet no audio detection module which + // will notify the user if the current selected microphone has no audio + // input and will suggest another valid device if one is present. + enableNoAudioDetection: true, + + // Enabling this will run the lib-jitsi-meet noise detection module which will + // notify the user if there is noise, other than voice, coming from the current + // selected microphone. The purpose it to let the user know that the input could + // be potentially unpleasant for other meeting participants. + enableNoisyMicDetection: true, + + // Start the conference in audio only mode (no video is being received nor + // sent). + // startAudioOnly: false, + + // Every participant after the Nth will start audio muted. + // startAudioMuted: 10, + + // Start calls with audio muted. Unlike the option above, this one is only + // applied locally. FIXME: having these 2 options is confusing. + // startWithAudioMuted: false, + + // Enabling it (with #params) will disable local audio output of remote + // participants and to enable it back a reload is needed. + // startSilent: false + + // Sets the preferred target bitrate for the Opus audio codec by setting its + // 'maxaveragebitrate' parameter. Currently not available in p2p mode. + // Valid values are in the range 6000 to 510000 + // opusMaxAverageBitrate: 20000, + + // Enables redundancy for Opus + // enableOpusRed: false + + // Video + + // Sets the preferred resolution (height) for local video. Defaults to 720. + // resolution: 720, + + // How many participants while in the tile view mode, before the receiving video quality is reduced from HD to SD. + // Use -1 to disable. + // maxFullResolutionParticipants: 2, + + // w3c spec-compliant video constraints to use for video capture. Currently + // used by browsers that return true from lib-jitsi-meet's + // util#browser#usesNewGumFlow. The constraints are independent from + // this config's resolution value. Defaults to requesting an ideal + // resolution of 720p. + // constraints: { + // video: { + // height: { + // ideal: 720, + // max: 720, + // min: 240 + // } + // } + // }, + + // Enable / disable simulcast support. + // disableSimulcast: false, + + // Enable / disable layer suspension. If enabled, endpoints whose HD + // layers are not in use will be suspended (no longer sent) until they + // are requested again. + // enableLayerSuspension: false, + + // Every participant after the Nth will start video muted. + // startVideoMuted: 10, + + // Start calls with video muted. Unlike the option above, this one is only + // applied locally. FIXME: having these 2 options is confusing. + // startWithVideoMuted: false, + + // If set to true, prefer to use the H.264 video codec (if supported). + // Note that it's not recommended to do this because simulcast is not + // supported when using H.264. For 1-to-1 calls this setting is enabled by + // default and can be toggled in the p2p section. + // This option has been deprecated, use preferredCodec under videoQuality section instead. + // preferH264: true, + + // If set to true, disable H.264 video codec by stripping it out of the + // SDP. + // disableH264: false, + + // Desktop sharing + + // Optional desktop sharing frame rate options. Default value: min:5, max:5. + // desktopSharingFrameRate: { + // min: 5, + // max: 5 + // }, + + // Try to start calls with screen-sharing instead of camera video. + // startScreenSharing: false, + + // Recording + + // Whether to enable file recording or not. + // fileRecordingsEnabled: false, + // Enable the dropbox integration. + // dropbox: { + // appKey: '' // Specify your app key here. + // // A URL to redirect the user to, after authenticating + // // by default uses: + // // 'https://jitsi-meet.example.org/static/oauth.html' + // redirectURI: + // 'https://jitsi-meet.example.org/subfolder/static/oauth.html' + // }, + // When integrations like dropbox are enabled only that will be shown, + // by enabling fileRecordingsServiceEnabled, we show both the integrations + // and the generic recording service (its configuration and storage type + // depends on jibri configuration) + // fileRecordingsServiceEnabled: false, + // Whether to show the possibility to share file recording with other people + // (e.g. meeting participants), based on the actual implementation + // on the backend. + // fileRecordingsServiceSharingEnabled: false, + + // Whether to enable live streaming or not. + // liveStreamingEnabled: false, + + // Transcription (in interface_config, + // subtitles and buttons can be configured) + // transcribingEnabled: false, + + // Enables automatic turning on captions when recording is started + // autoCaptionOnRecord: false, + + // Misc + + // Default value for the channel "last N" attribute. -1 for unlimited. + channelLastN: -1, + + // Provides a way to use different "last N" values based on the number of participants in the conference. + // The keys in an Object represent number of participants and the values are "last N" to be used when number of + // participants gets to or above the number. + // + // For the given example mapping, "last N" will be set to 20 as long as there are at least 5, but less than + // 29 participants in the call and it will be lowered to 15 when the 30th participant joins. The 'channelLastN' + // will be used as default until the first threshold is reached. + // + // lastNLimits: { + // 5: 20, + // 30: 15, + // 50: 10, + // 70: 5, + // 90: 2 + // }, + + // Specify the settings for video quality optimizations on the client. + // videoQuality: { + // // Provides a way to prevent a video codec from being negotiated on the JVB connection. The codec specified + // // here will be removed from the list of codecs present in the SDP answer generated by the client. If the + // // same codec is specified for both the disabled and preferred option, the disable settings will prevail. + // // Note that 'VP8' cannot be disabled since it's a mandatory codec, the setting will be ignored in this case. + // disabledCodec: 'H264', + // + // // Provides a way to set a preferred video codec for the JVB connection. If 'H264' is specified here, + // // simulcast will be automatically disabled since JVB doesn't support H264 simulcast yet. This will only + // // rearrange the the preference order of the codecs in the SDP answer generated by the browser only if the + // // preferred codec specified here is present. Please ensure that the JVB offers the specified codec for this + // // to take effect. + // preferredCodec: 'VP8', + // + // // Provides a way to configure the maximum bitrates that will be enforced on the simulcast streams for + // // video tracks. The keys in the object represent the type of the stream (LD, SD or HD) and the values + // // are the max.bitrates to be set on that particular type of stream. The actual send may vary based on + // // the available bandwidth calculated by the browser, but it will be capped by the values specified here. + // // This is currently not implemented on app based clients on mobile. + // maxBitratesVideo: { + // low: 200000, + // standard: 500000, + // high: 1500000 + // }, + // + // // The options can be used to override default thresholds of video thumbnail heights corresponding to + // // the video quality levels used in the application. At the time of this writing the allowed levels are: + // // 'low' - for the low quality level (180p at the time of this writing) + // // 'standard' - for the medium quality level (360p) + // // 'high' - for the high quality level (720p) + // // The keys should be positive numbers which represent the minimal thumbnail height for the quality level. + // // + // // With the default config value below the application will use 'low' quality until the thumbnails are + // // at least 360 pixels tall. If the thumbnail height reaches 720 pixels then the application will switch to + // // the high quality. + // minHeightForQualityLvl: { + // 360: 'standard, + // 720: 'high' + // } + // }, + + // // Options for the recording limit notification. + // recordingLimit: { + // + // // The recording limit in minutes. Note: This number appears in the notification text + // // but doesn't enforce the actual recording time limit. This should be configured in + // // jibri! + // limit: 60, + // + // // The name of the app with unlimited recordings. + // appName: 'Unlimited recordings APP', + // + // // The URL of the app with unlimited recordings. + // appURL: 'https://unlimited.recordings.app.com/' + // }, + + // Disables or enables RTX (RFC 4588) (defaults to false). + // disableRtx: false, + + // Disables or enables TCC (the default is in Jicofo and set to true) + // (draft-holmer-rmcat-transport-wide-cc-extensions-01). This setting + // affects congestion control, it practically enables send-side bandwidth + // estimations. + // enableTcc: true, + + // Disables or enables REMB (the default is in Jicofo and set to false) + // (draft-alvestrand-rmcat-remb-03). This setting affects congestion + // control, it practically enables recv-side bandwidth estimations. When + // both TCC and REMB are enabled, TCC takes precedence. When both are + // disabled, then bandwidth estimations are disabled. + // enableRemb: false, + + // Enables ICE restart logic in LJM and displays the page reload overlay on + // ICE failure. Current disabled by default because it's causing issues with + // signaling when Octo is enabled. Also when we do an "ICE restart"(which is + // not a real ICE restart), the client maintains the TCC sequence number + // counter, but the bridge resets it. The bridge sends media packets with + // TCC sequence numbers starting from 0. + // enableIceRestart: false, + + // Defines the minimum number of participants to start a call (the default + // is set in Jicofo and set to 2). + // minParticipants: 2, + + // Use TURN/UDP servers for the jitsi-videobridge connection (by default + // we filter out TURN/UDP because it is usually not needed since the + // bridge itself is reachable via UDP) + // useTurnUdp: false + + // Enables / disables a data communication channel with the Videobridge. + // Values can be 'datachannel', 'websocket', true (treat it as + // 'datachannel'), undefined (treat it as 'datachannel') and false (don't + // open any channel). + // openBridgeChannel: true, + openBridgeChannel: 'websocket', + + + // UI + // + + // Hides lobby button + // hideLobbyButton: false, + + // Require users to always specify a display name. + // requireDisplayName: true, + + // Whether to use a welcome page or not. In case it's false a random room + // will be joined when no room is specified. + enableWelcomePage: true, + + // Enabling the close page will ignore the welcome page redirection when + // a call is hangup. + // enableClosePage: false, + + // Disable hiding of remote thumbnails when in a 1-on-1 conference call. + // disable1On1Mode: false, + + // Default language for the user interface. + // defaultLanguage: 'en', + + // If true all users without a token will be considered guests and all users + // with token will be considered non-guests. Only guests will be allowed to + // edit their profile. + enableUserRolesBasedOnToken: false, + + // Whether or not some features are checked based on token. + // enableFeaturesBasedOnToken: false, + + // Enable lock room for all moderators, even when userRolesBasedOnToken is enabled and participants are guests. + // lockRoomGuestEnabled: false, + + // When enabled the password used for locking a room is restricted to up to the number of digits specified + // roomPasswordNumberOfDigits: 10, + // default: roomPasswordNumberOfDigits: false, + + // Message to show the users. Example: 'The service will be down for + // maintenance at 01:00 AM GMT, + // noticeMessage: '', + + // Enables calendar integration, depends on googleApiApplicationClientID + // and microsoftApiApplicationClientID + // enableCalendarIntegration: false, + + // When 'true', it shows an intermediate page before joining, where the user can configure their devices. + // prejoinPageEnabled: false, + + // If true, shows the unsafe room name warning label when a room name is + // deemed unsafe (due to the simplicity in the name) and a password is not + // set or the lobby is not enabled. + // enableInsecureRoomNameWarning: false, + + // Whether to automatically copy invitation URL after creating a room. + // Document should be focused for this option to work + // enableAutomaticUrlCopy: false, + + // Stats + // + + // Whether to enable stats collection or not in the TraceablePeerConnection. + // This can be useful for debugging purposes (post-processing/analysis of + // the webrtc stats) as it is done in the jitsi-meet-torture bandwidth + // estimation tests. + // gatherStats: false, + + // The interval at which PeerConnection.getStats() is called. Defaults to 10000 + // pcStatsInterval: 10000, + + // To enable sending statistics to callstats.io you must provide the + // Application ID and Secret. + // callStatsID: '', + // callStatsSecret: '', + + // Enables sending participants' display names to callstats + // enableDisplayNameInStats: false, + + // Enables sending participants' emails (if available) to callstats and other analytics + // enableEmailInStats: false, + + // Privacy + // + + // If third party requests are disabled, no other server will be contacted. + // This means avatars will be locally generated and callstats integration + // will not function. + // disableThirdPartyRequests: false, + + + // Peer-To-Peer mode: used (if enabled) when there are just 2 participants. + // + + p2p: { + // Enables peer to peer mode. When enabled the system will try to + // establish a direct connection when there are exactly 2 participants + // in the room. If that succeeds the conference will stop sending data + // through the JVB and use the peer to peer connection instead. When a + // 3rd participant joins the conference will be moved back to the JVB + // connection. + enabled: true, + + // The STUN servers that will be used in the peer to peer connections + stunServers: [ + + // { urls: 'stun:jitsi-meet.example.org:3478' }, + { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' } + ] + + // Sets the ICE transport policy for the p2p connection. At the time + // of this writing the list of possible values are 'all' and 'relay', + // but that is subject to change in the future. The enum is defined in + // the WebRTC standard: + // https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum. + // If not set, the effective value is 'all'. + // iceTransportPolicy: 'all', + + // If set to true, it will prefer to use H.264 for P2P calls (if H.264 + // is supported). This setting is deprecated, use preferredCodec instead. + // preferH264: true + + // Provides a way to set the video codec preference on the p2p connection. Acceptable + // codec values are 'VP8', 'VP9' and 'H264'. + // preferredCodec: 'H264', + + // If set to true, disable H.264 video codec by stripping it out of the + // SDP. This setting is deprecated, use disabledCodec instead. + // disableH264: false, + + // Provides a way to prevent a video codec from being negotiated on the p2p connection. + // disabledCodec: '', + + // How long we're going to wait, before going back to P2P after the 3rd + // participant has left the conference (to filter out page reload). + // backToP2PDelay: 5 + }, + + analytics: { + // The Google Analytics Tracking ID: + // googleAnalyticsTrackingId: 'your-tracking-id-UA-123456-1' + + // Matomo configuration: + // matomoEndpoint: 'https://your-matomo-endpoint/', + // matomoSiteID: '42', + + // The Amplitude APP Key: + // amplitudeAPPKey: '' + + // Configuration for the rtcstats server: + // By enabling rtcstats server every time a conference is joined the rtcstats + // module connects to the provided rtcstatsEndpoint and sends statistics regarding + // PeerConnection states along with getStats metrics polled at the specified + // interval. + // rtcstatsEnabled: true, + + // In order to enable rtcstats one needs to provide a endpoint url. + // rtcstatsEndpoint: wss://rtcstats-server-pilot.jitsi.net/, + + // The interval at which rtcstats will poll getStats, defaults to 1000ms. + // If the value is set to 0 getStats won't be polled and the rtcstats client + // will only send data related to RTCPeerConnection events. + // rtcstatsPolIInterval: 1000 + + // Array of script URLs to load as lib-jitsi-meet "analytics handlers". + // scriptURLs: [ + // "libs/analytics-ga.min.js", // google-analytics + // "https://example.com/my-custom-analytics.js" + // ], + }, + + // Logs that should go be passed through the 'log' event if a handler is defined for it + // apiLogLevels: ['warn', 'log', 'error', 'info', 'debug'], + + // Information about the jitsi-meet instance we are connecting to, including + // the user region as seen by the server. + deploymentInfo: { + // shard: "shard1", + // region: "europe", + // userRegion: "asia" + }, + + // Decides whether the start/stop recording audio notifications should play on record. + // disableRecordAudioNotification: false, + + // Information for the chrome extension banner + // chromeExtensionBanner: { + // // The chrome extension to be installed address + // url: 'https://chrome.google.com/webstore/detail/jitsi-meetings/kglhbbefdnlheedjiejgomgmfplipfeb', + + // // Extensions info which allows checking if they are installed or not + // chromeExtensionsInfo: [ + // { + // id: 'kglhbbefdnlheedjiejgomgmfplipfeb', + // path: 'jitsi-logo-48x48.png' + // } + // ] + // }, + + // Local Recording + // + + // localRecording: { + // Enables local recording. + // Additionally, 'localrecording' (all lowercase) needs to be added to + // TOOLBAR_BUTTONS in interface_config.js for the Local Recording + // button to show up on the toolbar. + // + // enabled: true, + // + + // The recording format, can be one of 'ogg', 'flac' or 'wav'. + // format: 'flac' + // + + // }, + + // Options related to end-to-end (participant to participant) ping. + // e2eping: { + // // The interval in milliseconds at which pings will be sent. + // // Defaults to 10000, set to <= 0 to disable. + // pingInterval: 10000, + // + // // The interval in milliseconds at which analytics events + // // with the measured RTT will be sent. Defaults to 60000, set + // // to <= 0 to disable. + // analyticsInterval: 60000, + // }, + + // If set, will attempt to use the provided video input device label when + // triggering a screenshare, instead of proceeding through the normal flow + // for obtaining a desktop stream. + // NOTE: This option is experimental and is currently intended for internal + // use only. + // _desktopSharingSourceDevice: 'sample-id-or-label', + + // If true, any checks to handoff to another application will be prevented + // and instead the app will continue to display in the current browser. + // disableDeepLinking: false, + + // A property to disable the right click context menu for localVideo + // the menu has option to flip the locally seen video for local presentations + // disableLocalVideoFlip: false, + + // Mainly privacy related settings + + // Disables all invite functions from the app (share, invite, dial out...etc) + // disableInviteFunctions: true, + + // Disables storing the room name to the recents list + // doNotStoreRoom: true, + + // Deployment specific URLs. + // deploymentUrls: { + // // If specified a 'Help' button will be displayed in the overflow menu with a link to the specified URL for + // // user documentation. + // userDocumentationURL: 'https://docs.example.com/video-meetings.html', + // // If specified a 'Download our apps' button will be displayed in the overflow menu with a link + // // to the specified URL for an app download page. + // downloadAppsUrl: 'https://docs.example.com/our-apps.html' + // }, + + // Options related to the remote participant menu. + // remoteVideoMenu: { + // // If set to true the 'Kick out' button will be disabled. + // disableKick: true + // }, + + // If set to true all muting operations of remote participants will be disabled. + // disableRemoteMute: true, + + /** + External API url used to receive branding specific information. + If there is no url set or there are missing fields, the defaults are applied. + None of the fields are mandatory and the response must have the shape: + { + // The hex value for the colour used as background + backgroundColor: '#fff', + // The url for the image used as background + backgroundImageUrl: 'https://example.com/background-img.png', + // The anchor url used when clicking the logo image + logoClickUrl: 'https://example-company.org', + // The url used for the image used as logo + logoImageUrl: 'https://example.com/logo-img.png' + } + */ + // brandingDataUrl: '', + + // The URL of the moderated rooms microservice, if available. If it + // is present, a link to the service will be rendered on the welcome page, + // otherwise the app doesn't render it. + // moderatedRoomServiceUrl: 'https://moderated.jitsi-meet.example.org', + + // List of undocumented settings used in jitsi-meet + /** + _immediateReloadThreshold + debug + debugAudioLevels + deploymentInfo + dialInConfCodeUrl + dialInNumbersUrl + dialOutAuthUrl + dialOutCodesUrl + disableRemoteControl + displayJids + etherpad_base + externalConnectUrl + firefox_fake_device + googleApiApplicationClientID + iAmRecorder + iAmSipGateway + microsoftApiApplicationClientID + peopleSearchQueryTypes + peopleSearchUrl + requireDisplayName + tokenAuthUrl + */ + + /** + * This property can be used to alter the generated meeting invite links (in combination with a branding domain + * which is retrieved internally by jitsi meet) (e.g. https://meet.jit.si/someMeeting + * can become https://brandedDomain/roomAlias) + */ + // brandingRoomAlias: null, + + // List of undocumented settings used in lib-jitsi-meet + /** + _peerConnStatusOutOfLastNTimeout + _peerConnStatusRtcMuteTimeout + abTesting + avgRtpStatsN + callStatsConfIDNamespace + callStatsCustomScriptUrl + desktopSharingSources + disableAEC + disableAGC + disableAP + disableHPF + disableNS + enableLipSync + enableTalkWhileMuted + forceJVB121Ratio + hiddenDomain + ignoreStartMuted + nick + startBitrate + */ + + + // Allow all above example options to include a trailing comma and + // prevent fear when commenting out the last value. + makeJsonParserHappy: 'even if last key had a trailing comma' + + // no configuration value should follow this line. +}; + +/* eslint-enable no-unused-vars, no-var */ diff --git a/type/__evilham_jitsi_meet_domain/files/nginx.sh b/type/__evilham_jitsi_meet_domain/files/nginx.sh new file mode 100644 index 0000000..bb300fd --- /dev/null +++ b/type/__evilham_jitsi_meet_domain/files/nginx.sh @@ -0,0 +1,156 @@ +#!/bin/sh -e + +# shellcheck disable=SC2034 # This is intended to be included +JITSI_NGINX_CONFIG="$(cat < + + +COPYING +------- +Copyright \(C) 2020 Evilham. diff --git a/type/__evilham_jitsi_meet_domain/manifest b/type/__evilham_jitsi_meet_domain/manifest new file mode 100755 index 0000000..8d28256 --- /dev/null +++ b/type/__evilham_jitsi_meet_domain/manifest @@ -0,0 +1,88 @@ +#!/bin/sh -e + +os="$(cat "${__global}/explorer/os")" +case "${os}" in + devuan|debian) + ;; + *) + echo "Your OS '${os}' is currently not supported." > /dev/stderr + exit 1 + ;; +esac + +DOMAIN="${__object_id}" +ADMIN_EMAIL="$(cat "${__object}/parameter/admin-email")" +CHANNEL_LAST_N="$(cat "${__object}/parameter/channel-last-n")" +DEFAULT_LANGUAGE="$(cat "${__object}/parameter/default-language")" +NOTICE_MESSAGE="$(cat "${__object}/parameter/notice-message")" +START_VIDEO_MUTED="$(cat "${__object}/parameter/start-video-muted")" +TURN_SERVER="$(cat "${__object}/parameter/turn-server")" +VIDEO_CONSTRAINTS="$(cat "${__object}/parameter/video-constraints")" +BRANDING_INDEX="$(cat "${__object}/parameter/branding-index")" +BRANDING_JSON="$(cat "${__object}/parameter/branding-json")" +BRANDING_WATERMARK="$(cat "${__object}/parameter/branding-watermark")" + +if [ -f "${__object}/parameter/enable-third-party-requests" ]; then + ENABLE_THIRD_PARTY_REQUESTS="YES" +fi +if [ -f "${__object}/parameter/disable-audio-levels" ]; then + DISABLE_AUDIO_LEVELS="YES" +fi + +if [ -z "${TURN_SERVER}" ]; then + TURN_SERVER="${__target_host}" +fi +if [ -z "${JITSI_HOST}" ]; then + JITSI_HOST="${__target_host}" +fi + +# +# Deal with certbot +# +# use object id as domain +__letsencrypt_cert "${DOMAIN}" \ + --admin-email "${ADMIN_EMAIL}" \ + --automatic-renewal \ + --renew-hook "service nginx reload" \ + --webroot /usr/share/jitsi-meet + +# Create virtualhost for nginx +. "${__type}/files/nginx.sh" # This defines JITSI_NGINX_CONFIG +require="__letsencrypt_cert/${DOMAIN}" __file \ + "/etc/nginx/sites-enabled/${DOMAIN}.conf" \ + --mode 0644 --source "-" < Date: Mon, 11 Jan 2021 12:01:04 +0100 Subject: [PATCH 2/6] 'unbrand' evilham's jitsi types --- .../prometheus-jitsi-meet-explorer-version | 0 .../files/debconf_settings.sh | 0 .../files/ufw | 0 .../gencode-remote | 0 .../man.rst | 14 +++++++------- .../manifest | 0 .../parameter/boolean | 0 .../parameter/default/turn-server | 0 .../parameter/optional | 0 .../singleton | 0 .../files/config.js.sh | 0 .../files/config.js.sh.orig | 0 .../files/nginx.sh | 0 .../files/nginx.sh.orig | 0 .../gencode-remote | 0 .../man.rst | 17 ++++++++--------- .../manifest | 0 .../parameter/boolean | 0 .../parameter/default/branding-index | 0 .../parameter/default/branding-json | 0 .../parameter/default/branding-watermark | 0 .../parameter/default/channel-last-n | 0 .../parameter/default/default-language | 0 .../parameter/default/notice-message | 0 .../parameter/default/start-video-muted | 0 .../parameter/default/turn-server | 0 .../parameter/default/video-constraints | 0 .../parameter/optional | 0 .../parameter/required | 0 29 files changed, 15 insertions(+), 16 deletions(-) rename type/{__evilham_jitsi_meet => __jitsi_meet}/explorer/prometheus-jitsi-meet-explorer-version (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/files/debconf_settings.sh (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/files/ufw (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/gencode-remote (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/man.rst (82%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/manifest (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/parameter/boolean (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/parameter/default/turn-server (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/parameter/optional (100%) rename type/{__evilham_jitsi_meet => __jitsi_meet}/singleton (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/files/config.js.sh (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/files/config.js.sh.orig (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/files/nginx.sh (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/files/nginx.sh.orig (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/gencode-remote (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/man.rst (87%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/manifest (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/boolean (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/branding-index (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/branding-json (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/branding-watermark (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/channel-last-n (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/default-language (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/notice-message (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/start-video-muted (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/turn-server (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/default/video-constraints (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/optional (100%) rename type/{__evilham_jitsi_meet_domain => __jitsi_meet_domain}/parameter/required (100%) diff --git a/type/__evilham_jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version b/type/__jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version similarity index 100% rename from type/__evilham_jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version rename to type/__jitsi_meet/explorer/prometheus-jitsi-meet-explorer-version diff --git a/type/__evilham_jitsi_meet/files/debconf_settings.sh b/type/__jitsi_meet/files/debconf_settings.sh similarity index 100% rename from type/__evilham_jitsi_meet/files/debconf_settings.sh rename to type/__jitsi_meet/files/debconf_settings.sh diff --git a/type/__evilham_jitsi_meet/files/ufw b/type/__jitsi_meet/files/ufw similarity index 100% rename from type/__evilham_jitsi_meet/files/ufw rename to type/__jitsi_meet/files/ufw diff --git a/type/__evilham_jitsi_meet/gencode-remote b/type/__jitsi_meet/gencode-remote similarity index 100% rename from type/__evilham_jitsi_meet/gencode-remote rename to type/__jitsi_meet/gencode-remote diff --git a/type/__evilham_jitsi_meet/man.rst b/type/__jitsi_meet/man.rst similarity index 82% rename from type/__evilham_jitsi_meet/man.rst rename to type/__jitsi_meet/man.rst index b97130b..3d02346 100644 --- a/type/__evilham_jitsi_meet/man.rst +++ b/type/__jitsi_meet/man.rst @@ -1,10 +1,10 @@ -cdist-type__evilham_jitsi_meet(7) +cdist-type__jitsi_meet(7) ================================= NAME ---- -cdist-type__evilham_jitsi_meet - Setup the server-side of Jitsi-Meet. +cdist-type__jitsi_meet - Setup the server-side of Jitsi-Meet. DESCRIPTION @@ -17,8 +17,8 @@ eXO's notes for installing and managing Jitsi Meet instances. This type also sets up nginx in a way that is compatible with `__letsencrypt_cert` and assumes that it will only serve Jitsi instances. -You will also need the `__evilham_jitsi_meet_domain` type in order to finish -setting up the web frontend (including TLS certificates) and its settings. +You will also need the `__jitsi_meet_domain` type in order to finish setting up +the web frontend (including TLS certificates) and its settings. You may want to use the `files/ufw` example manifest for a `__ufw`-based firewall compatible with this type. @@ -60,17 +60,17 @@ EXAMPLES .. code-block:: sh # Setup the firewall - . "${__global}/type/__evilham_jitsi_meet/files/ufw" + . "${__global}/type/__jitsi_meet/files/ufw" export require="__ufw" # Setup Jitsi on this host - __evilham_jitsi_meet \ + __jitsi_meet \ --turn-server "turn.exo.cat" \ --turn-secret "WeNeedGoodSecurity" SEE ALSO -------- -- `__evilham_jitsi_meet_domain` +- `__jitsi_meet_domain` diff --git a/type/__evilham_jitsi_meet/manifest b/type/__jitsi_meet/manifest similarity index 100% rename from type/__evilham_jitsi_meet/manifest rename to type/__jitsi_meet/manifest diff --git a/type/__evilham_jitsi_meet/parameter/boolean b/type/__jitsi_meet/parameter/boolean similarity index 100% rename from type/__evilham_jitsi_meet/parameter/boolean rename to type/__jitsi_meet/parameter/boolean diff --git a/type/__evilham_jitsi_meet/parameter/default/turn-server b/type/__jitsi_meet/parameter/default/turn-server similarity index 100% rename from type/__evilham_jitsi_meet/parameter/default/turn-server rename to type/__jitsi_meet/parameter/default/turn-server diff --git a/type/__evilham_jitsi_meet/parameter/optional b/type/__jitsi_meet/parameter/optional similarity index 100% rename from type/__evilham_jitsi_meet/parameter/optional rename to type/__jitsi_meet/parameter/optional diff --git a/type/__evilham_jitsi_meet/singleton b/type/__jitsi_meet/singleton similarity index 100% rename from type/__evilham_jitsi_meet/singleton rename to type/__jitsi_meet/singleton diff --git a/type/__evilham_jitsi_meet_domain/files/config.js.sh b/type/__jitsi_meet_domain/files/config.js.sh similarity index 100% rename from type/__evilham_jitsi_meet_domain/files/config.js.sh rename to type/__jitsi_meet_domain/files/config.js.sh diff --git a/type/__evilham_jitsi_meet_domain/files/config.js.sh.orig b/type/__jitsi_meet_domain/files/config.js.sh.orig similarity index 100% rename from type/__evilham_jitsi_meet_domain/files/config.js.sh.orig rename to type/__jitsi_meet_domain/files/config.js.sh.orig diff --git a/type/__evilham_jitsi_meet_domain/files/nginx.sh b/type/__jitsi_meet_domain/files/nginx.sh similarity index 100% rename from type/__evilham_jitsi_meet_domain/files/nginx.sh rename to type/__jitsi_meet_domain/files/nginx.sh diff --git a/type/__evilham_jitsi_meet_domain/files/nginx.sh.orig b/type/__jitsi_meet_domain/files/nginx.sh.orig similarity index 100% rename from type/__evilham_jitsi_meet_domain/files/nginx.sh.orig rename to type/__jitsi_meet_domain/files/nginx.sh.orig diff --git a/type/__evilham_jitsi_meet_domain/gencode-remote b/type/__jitsi_meet_domain/gencode-remote similarity index 100% rename from type/__evilham_jitsi_meet_domain/gencode-remote rename to type/__jitsi_meet_domain/gencode-remote diff --git a/type/__evilham_jitsi_meet_domain/man.rst b/type/__jitsi_meet_domain/man.rst similarity index 87% rename from type/__evilham_jitsi_meet_domain/man.rst rename to type/__jitsi_meet_domain/man.rst index ea997f4..862701a 100644 --- a/type/__evilham_jitsi_meet_domain/man.rst +++ b/type/__jitsi_meet_domain/man.rst @@ -1,10 +1,10 @@ -cdist-type__evilham_jitsi_meet_domain(7) +cdist-type__jitsi_meet_domain(7) ======================================== NAME ---- -cdist-type__evilham_jitsi_meet_domain - Setup a frontend for Jitsi-Meet. +cdist-type__jitsi_meet_domain - Setup a frontend for Jitsi-Meet. DESCRIPTION @@ -20,9 +20,8 @@ This is due to the underlying XMPP and signaling rooms being common. There might be a way to perform tricks on the Nginx-side to avoid this, but time is lacking :-). -This assumes `__evilham_jitsi_meet` has already been ran on the target host, -and, amongst others, that Jitsi was set up with `__target_host` as the Jitsi -domain. +This assumes `__jitsi_meet` has already been ran on the target host, and, +amongst others, that Jitsi was set up with `__target_host` as the Jitsi domain. This type will take care of TLS settings, branding and client-side configuration for Jitsi. @@ -73,13 +72,13 @@ video-constraints this config's resolution value. Defaults to requesting an ideal resolution of 720p. It must not have a trailing comma, see `constraints` in - `__evilham_jitsi_meet_domain/files/config.js.sh`. + `__jitsi_meet_domain/files/config.js.sh`. branding-json Path to a JSON file that will be served as the `brandingDataUrl`. For information on the format see `brandingDataUrl` in - `__evilham_jitsi_meet_domain/files/config.js.sh`. + `__jitsi_meet_domain/files/config.js.sh`. If not set, no branding will be set up. @@ -114,7 +113,7 @@ EXAMPLES .. code-block:: sh # Setup a Jitsi frontend for jitsi.exo.cat - __evilham_jitsi_meet_domain "jitsi.exo.cat" \ + __jitsi_meet_domain "jitsi.exo.cat" \ --admin-email "info@exo.cat" \ --turn-server "turn.exo.cat" \ --notice-message "Hola!" \ @@ -137,7 +136,7 @@ EXAMPLES SEE ALSO -------- -- `__evilham_jitsi_meet` +- `__jitsi_meet` diff --git a/type/__evilham_jitsi_meet_domain/manifest b/type/__jitsi_meet_domain/manifest similarity index 100% rename from type/__evilham_jitsi_meet_domain/manifest rename to type/__jitsi_meet_domain/manifest diff --git a/type/__evilham_jitsi_meet_domain/parameter/boolean b/type/__jitsi_meet_domain/parameter/boolean similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/boolean rename to type/__jitsi_meet_domain/parameter/boolean diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/branding-index b/type/__jitsi_meet_domain/parameter/default/branding-index similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/branding-index rename to type/__jitsi_meet_domain/parameter/default/branding-index diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/branding-json b/type/__jitsi_meet_domain/parameter/default/branding-json similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/branding-json rename to type/__jitsi_meet_domain/parameter/default/branding-json diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/branding-watermark b/type/__jitsi_meet_domain/parameter/default/branding-watermark similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/branding-watermark rename to type/__jitsi_meet_domain/parameter/default/branding-watermark diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/channel-last-n b/type/__jitsi_meet_domain/parameter/default/channel-last-n similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/channel-last-n rename to type/__jitsi_meet_domain/parameter/default/channel-last-n diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/default-language b/type/__jitsi_meet_domain/parameter/default/default-language similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/default-language rename to type/__jitsi_meet_domain/parameter/default/default-language diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/notice-message b/type/__jitsi_meet_domain/parameter/default/notice-message similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/notice-message rename to type/__jitsi_meet_domain/parameter/default/notice-message diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/start-video-muted b/type/__jitsi_meet_domain/parameter/default/start-video-muted similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/start-video-muted rename to type/__jitsi_meet_domain/parameter/default/start-video-muted diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/turn-server b/type/__jitsi_meet_domain/parameter/default/turn-server similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/turn-server rename to type/__jitsi_meet_domain/parameter/default/turn-server diff --git a/type/__evilham_jitsi_meet_domain/parameter/default/video-constraints b/type/__jitsi_meet_domain/parameter/default/video-constraints similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/default/video-constraints rename to type/__jitsi_meet_domain/parameter/default/video-constraints diff --git a/type/__evilham_jitsi_meet_domain/parameter/optional b/type/__jitsi_meet_domain/parameter/optional similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/optional rename to type/__jitsi_meet_domain/parameter/optional diff --git a/type/__evilham_jitsi_meet_domain/parameter/required b/type/__jitsi_meet_domain/parameter/required similarity index 100% rename from type/__evilham_jitsi_meet_domain/parameter/required rename to type/__jitsi_meet_domain/parameter/required From 367cbde75b81373d125ea128daaab5e1de8b38c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Mon, 11 Jan 2021 14:10:55 +0100 Subject: [PATCH 3/6] Import evilham's runit types as it --- type/__evilham_runit/explorer/runit-etc | 7 +++ type/__evilham_runit/explorer/svdir-exists | 7 +++ type/__evilham_runit/gencode-remote | 21 +++++++ type/__evilham_runit/man.rst | 46 +++++++++++++++ type/__evilham_runit/manifest | 10 ++++ type/__evilham_runit/singleton | 0 type/__evilham_runit_service/man.rst | 58 +++++++++++++++++++ type/__evilham_runit_service/manifest | 33 +++++++++++ .../__evilham_runit_service/parameter/boolean | 1 + .../parameter/required | 1 + 10 files changed, 184 insertions(+) create mode 100755 type/__evilham_runit/explorer/runit-etc create mode 100755 type/__evilham_runit/explorer/svdir-exists create mode 100755 type/__evilham_runit/gencode-remote create mode 100644 type/__evilham_runit/man.rst create mode 100755 type/__evilham_runit/manifest create mode 100644 type/__evilham_runit/singleton create mode 100644 type/__evilham_runit_service/man.rst create mode 100755 type/__evilham_runit_service/manifest create mode 100644 type/__evilham_runit_service/parameter/boolean create mode 100644 type/__evilham_runit_service/parameter/required diff --git a/type/__evilham_runit/explorer/runit-etc b/type/__evilham_runit/explorer/runit-etc new file mode 100755 index 0000000..4511621 --- /dev/null +++ b/type/__evilham_runit/explorer/runit-etc @@ -0,0 +1,7 @@ +#!/bin/sh -e + +runit_etc_dir="/etc/runit" + +if [ -d "${runit_etc_dir}" ]; then + echo "YES" +fi diff --git a/type/__evilham_runit/explorer/svdir-exists b/type/__evilham_runit/explorer/svdir-exists new file mode 100755 index 0000000..4eca3d4 --- /dev/null +++ b/type/__evilham_runit/explorer/svdir-exists @@ -0,0 +1,7 @@ +#!/bin/sh -e + +svdir="/var/service" + +if [ -d "${svdir}" ]; then + echo "YES" +fi diff --git a/type/__evilham_runit/gencode-remote b/type/__evilham_runit/gencode-remote new file mode 100755 index 0000000..fd2a3e0 --- /dev/null +++ b/type/__evilham_runit/gencode-remote @@ -0,0 +1,21 @@ +#!/bin/sh -e + +svdir="/var/service" +svdir_exists="$(cat "${__object}/explorer/svdir-exists")" +runit_etc="$(cat "${__object}/explorer/runit-etc")" + +if [ -z "${svdir_exists}" ]; then + echo "mkdir '${svdir}'" + sv_restart="YES" +fi +if [ -z "${runit_etc}" ]; then + echo "cp -R '/usr/local/etc/runit' '/etc/runit'" + sv_restart="YES" +fi +if grep -q "^__key_value/runsvdir_enable" "${__messages_in}"; then + sv_restart="YES" +fi + +if [ -n "${sv_restart}" ]; then + echo "service runsvdir restart || service runsvdir start" +fi diff --git a/type/__evilham_runit/man.rst b/type/__evilham_runit/man.rst new file mode 100644 index 0000000..bd1b80c --- /dev/null +++ b/type/__evilham_runit/man.rst @@ -0,0 +1,46 @@ +cdist-type__evilham_runit(7) +============================ + +NAME +---- +cdist-type__evilham_runit - Install and configure runit + + +DESCRIPTION +----------- +This is a singleton type. + +Install and configure runit, not as an init system, but as a service monitor. +It configures and if necessary starts runsvdir as documented for the +Operating System. + +This type currently heavily focuses on FreeBSD, support for other Operating +Systems can be achieved but no effort whatsoever has been put into it. + + +REQUIRED PARAMETERS +------------------- +None. + + +EXAMPLES +-------- + +.. code-block:: sh + + __evilham_runit + +SEE ALSO +-------- +:strong:`cdist-type__evilham_runit_service`\ (7) + +AUTHORS +------- +Evilham + +COPYING +------- +Copyright \(C) 2020 Evilham. You can redistribute it +and/or modify it under the terms of the GNU General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. diff --git a/type/__evilham_runit/manifest b/type/__evilham_runit/manifest new file mode 100755 index 0000000..195a70e --- /dev/null +++ b/type/__evilham_runit/manifest @@ -0,0 +1,10 @@ +#!/bin/sh -e + +__package "runit" + +__key_value \ + --file "/etc/rc.conf" \ + --key "runsvdir_enable" \ + --delimiter "=" \ + --value "yes" \ + "runsvdir_enable" diff --git a/type/__evilham_runit/singleton b/type/__evilham_runit/singleton new file mode 100644 index 0000000..e69de29 diff --git a/type/__evilham_runit_service/man.rst b/type/__evilham_runit_service/man.rst new file mode 100644 index 0000000..98bbc35 --- /dev/null +++ b/type/__evilham_runit_service/man.rst @@ -0,0 +1,58 @@ +cdist-type__evilham_runit_service(7) +==================================== + +NAME +---- +cdist-type__evilham_runit_service - Create a runit-compatible service dir. + + +DESCRIPTION +----------- +Create a directory structure compatible with runit-like service management. + +Note that sv(8) and runsvdir(8) must be present on the target system, this can +be achieved with e.g. `__runit`. + +The `__object_id` will be used as the service name. + + +REQUIRED PARAMETERS +------------------- +source + File to save as /run. If set to '-', standard input will be used. + + +BOOLEAN PARAMETERS +------------------ +log + Setup logging with `svlogd -tt ./main`. + + +EXAMPLES +-------- + +.. code-block:: sh + + require="__evilham_runit" __evilham_runit_service tasksched \ + --source - << EOF + #!/bin/sh -e + cd "${HOME}/.local/share/tasksched" + exec ./server.js 2>&1 + EOF + + +SEE ALSO +-------- +:strong:`cdist-type__evilham_runit`\ (7) + + +AUTHORS +------- +Evilham + +COPYING +------- +Copyright \(C) 2020 Evilham. You can redistribute it +and/or modify it under the terms of the GNU General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. diff --git a/type/__evilham_runit_service/manifest b/type/__evilham_runit_service/manifest new file mode 100755 index 0000000..29f3312 --- /dev/null +++ b/type/__evilham_runit_service/manifest @@ -0,0 +1,33 @@ +#!/bin/sh -e + +svdir="/var/service" +sv="${__object_id}" +state="present" +run_file="${svdir}/${sv}/run" + +source="$(cat "$__object/parameter/source")" +if [ "$source" = "-" ]; then + source="$__object/stdin" +fi + +# Create this service's directory +__directory --state "${state}" "${svdir}/${sv}" + +export require="__directory${svdir}/${sv}" + + +if [ -f "${__object}/parameter/log" ]; then + # Setup logger if requested + __directory --parents "${svdir}/${sv}/log/main" + export require="${require} __directory${svdir}/${sv}/log/main" + __file "${svdir}/${sv}/log/run" \ + --state "${state}" \ + --mode 0755 \ + --source "-" < Date: Mon, 11 Jan 2021 14:13:46 +0100 Subject: [PATCH 4/6] 'unbrand' evilham's runit types --- type/__jitsi_meet/manifest | 6 +++--- type/{__evilham_runit => __runit}/explorer/runit-etc | 0 type/{__evilham_runit => __runit}/explorer/svdir-exists | 0 type/{__evilham_runit => __runit}/gencode-remote | 0 type/{__evilham_runit => __runit}/man.rst | 8 ++++---- type/{__evilham_runit => __runit}/manifest | 0 type/{__evilham_runit => __runit}/singleton | 0 type/{__evilham_runit_service => __runit_service}/man.rst | 8 ++++---- .../{__evilham_runit_service => __runit_service}/manifest | 0 .../parameter/boolean | 0 .../parameter/required | 0 11 files changed, 11 insertions(+), 11 deletions(-) rename type/{__evilham_runit => __runit}/explorer/runit-etc (100%) rename type/{__evilham_runit => __runit}/explorer/svdir-exists (100%) rename type/{__evilham_runit => __runit}/gencode-remote (100%) rename type/{__evilham_runit => __runit}/man.rst (84%) rename type/{__evilham_runit => __runit}/manifest (100%) rename type/{__evilham_runit => __runit}/singleton (100%) rename type/{__evilham_runit_service => __runit_service}/man.rst (82%) rename type/{__evilham_runit_service => __runit_service}/manifest (100%) rename type/{__evilham_runit_service => __runit_service}/parameter/boolean (100%) rename type/{__evilham_runit_service => __runit_service}/parameter/required (100%) diff --git a/type/__jitsi_meet/manifest b/type/__jitsi_meet/manifest index 83d9dab..ec65883 100755 --- a/type/__jitsi_meet/manifest +++ b/type/__jitsi_meet/manifest @@ -145,8 +145,8 @@ PROMETHEUS_JITSI_EXPORTER_VERSION_FILE="/usr/local/bin/.prometheus-jitsi-meet-ex if [ ! -f "${__object}/parameter/disable-prometheus-exporter" ]; then case "${init}" in init|sysvinit) - __evilham_runit - require="__evilham_runit" __evilham_runit_service \ + __runit + require="__runit" __runit_service \ prometheus-jitsi-meet-exporter --log --source - <&1 EOF - export require="__evilham_runit_service/prometheus-jitsi-meet-exporter" + export require="__runit_service/prometheus-jitsi-meet-exporter" JITSI_MEET_EXPORTER_SERVICE="sv %s prometheus-jitsi-meet-exporter" ;; systemd) diff --git a/type/__evilham_runit/explorer/runit-etc b/type/__runit/explorer/runit-etc similarity index 100% rename from type/__evilham_runit/explorer/runit-etc rename to type/__runit/explorer/runit-etc diff --git a/type/__evilham_runit/explorer/svdir-exists b/type/__runit/explorer/svdir-exists similarity index 100% rename from type/__evilham_runit/explorer/svdir-exists rename to type/__runit/explorer/svdir-exists diff --git a/type/__evilham_runit/gencode-remote b/type/__runit/gencode-remote similarity index 100% rename from type/__evilham_runit/gencode-remote rename to type/__runit/gencode-remote diff --git a/type/__evilham_runit/man.rst b/type/__runit/man.rst similarity index 84% rename from type/__evilham_runit/man.rst rename to type/__runit/man.rst index bd1b80c..d58e143 100644 --- a/type/__evilham_runit/man.rst +++ b/type/__runit/man.rst @@ -1,9 +1,9 @@ -cdist-type__evilham_runit(7) +cdist-type__runit(7) ============================ NAME ---- -cdist-type__evilham_runit - Install and configure runit +cdist-type__runit - Install and configure runit DESCRIPTION @@ -28,11 +28,11 @@ EXAMPLES .. code-block:: sh - __evilham_runit + __runit SEE ALSO -------- -:strong:`cdist-type__evilham_runit_service`\ (7) +:strong:`cdist-type__runit_service`\ (7) AUTHORS ------- diff --git a/type/__evilham_runit/manifest b/type/__runit/manifest similarity index 100% rename from type/__evilham_runit/manifest rename to type/__runit/manifest diff --git a/type/__evilham_runit/singleton b/type/__runit/singleton similarity index 100% rename from type/__evilham_runit/singleton rename to type/__runit/singleton diff --git a/type/__evilham_runit_service/man.rst b/type/__runit_service/man.rst similarity index 82% rename from type/__evilham_runit_service/man.rst rename to type/__runit_service/man.rst index 98bbc35..7b1db84 100644 --- a/type/__evilham_runit_service/man.rst +++ b/type/__runit_service/man.rst @@ -1,9 +1,9 @@ -cdist-type__evilham_runit_service(7) +cdist-type__runit_service(7) ==================================== NAME ---- -cdist-type__evilham_runit_service - Create a runit-compatible service dir. +cdist-type__runit_service - Create a runit-compatible service dir. DESCRIPTION @@ -33,7 +33,7 @@ EXAMPLES .. code-block:: sh - require="__evilham_runit" __evilham_runit_service tasksched \ + require="__runit" __runit_service tasksched \ --source - << EOF #!/bin/sh -e cd "${HOME}/.local/share/tasksched" @@ -43,7 +43,7 @@ EXAMPLES SEE ALSO -------- -:strong:`cdist-type__evilham_runit`\ (7) +:strong:`cdist-type__runit`\ (7) AUTHORS diff --git a/type/__evilham_runit_service/manifest b/type/__runit_service/manifest similarity index 100% rename from type/__evilham_runit_service/manifest rename to type/__runit_service/manifest diff --git a/type/__evilham_runit_service/parameter/boolean b/type/__runit_service/parameter/boolean similarity index 100% rename from type/__evilham_runit_service/parameter/boolean rename to type/__runit_service/parameter/boolean diff --git a/type/__evilham_runit_service/parameter/required b/type/__runit_service/parameter/required similarity index 100% rename from type/__evilham_runit_service/parameter/required rename to type/__runit_service/parameter/required From a1620e8221738d30eb1f15230f5e8e093b493f8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Tue, 12 Jan 2021 16:32:29 +0100 Subject: [PATCH 5/6] __jitsi_meet: remove forgotten/invalid requirement --- type/__jitsi_meet/manifest | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/type/__jitsi_meet/manifest b/type/__jitsi_meet/manifest index ec65883..f5fbe8c 100755 --- a/type/__jitsi_meet/manifest +++ b/type/__jitsi_meet/manifest @@ -33,7 +33,7 @@ require="__package/gnupg2" __apt_key_uri jitsi_meet \ --uri https://download.jitsi.org/jitsi-key.gpg.key \ --state present ## Now the repositories (they are a tad weird, so distribution is 'stable/') -require="__ufw __apt_key_uri/jitsi_meet" __apt_source jitsi_meet \ +require="__apt_key_uri/jitsi_meet" __apt_source jitsi_meet \ --uri 'https://download.jitsi.org' \ --distribution 'stable/' \ --state present From 87d4c33e26b2b8fa67da0dcbc01a9f70f5e9c705 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Wed, 13 Jan 2021 08:54:28 +0100 Subject: [PATCH 6/6] Make shellcheck happy with the __jitsi_* types --- type/__jitsi_meet/manifest | 6 +++--- type/__jitsi_meet_domain/manifest | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/type/__jitsi_meet/manifest b/type/__jitsi_meet/manifest index f5fbe8c..d4d16dc 100755 --- a/type/__jitsi_meet/manifest +++ b/type/__jitsi_meet/manifest @@ -43,6 +43,7 @@ require="__apt_source/jitsi_meet" __apt_update_index export require="${require} __apt_source/jitsi_meet __apt_update_index" # Pre-feed debconf settings, so Jitsi's installation has a good config +# shellcheck source=type/__jitsi_meet/files/debconf_settings.sh . "${__type}/files/debconf_settings.sh" # This defines DEBCONF_SETTINGS __debconf_set_selections jitsi_meet --file - <