SchildiChat Web/Desktop is a fork of Element Web/Desktop.
git clone -b lite --recurse-submodules https://github.com/SchildiChat/schildichat-desktop.git
cd schildichat-desktop
make setup # optional step if using the other make targets
Easiest to build on Linux is using podman
, i.e. use one of the following make targets:
make container-appimage-release
make container-debian-release
make container-rpm-release
make container-web-release
To build on Windows, use Element's guide as starting point.
Some additional notes I found useful:
To prepare your build environment for VSC tools (use 2022 rather than 2019 mentioned upstream:
"C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Auxiliary\Build\vcvarsall.bat" amd64
Additionally, make sure some programs are in your PATH
:
export PATH="/C/Strawberry/perl/bin:$PATH:/C/Program Files/NASM:/C/Program Files (x86)/Microsoft Visual Studio/2022/BuildTools/VC/Tools/MSVC/14.41.34120/bin/Hostx64/x64/"
- Strawberry perl needs to go before possibly already installed
/usr/bin/perl
- NASM needs to be available
nmake
bundled with VSC wasn't available without adding that additionally (make sure the version is correct for what you installed)
npm install yarn
npm install gyp
npm install electron-builder
npm install @electron/fuses
pip install setuptools
To update outdated npm packages:
npm outdated
npm update <name>
yarn link
fails with permission denied: kill any running nodejs taskelectron-builder
fails to extractwinCodeSign
:- Download source code manually
- Extract
electron-builder-binaries-winCodeSign-2.6.0.zip\electron-builder-binaries-winCodeSign-2.6.0\winCodeSign
to your `AppData\Local\electron-builder\Cache\winCodeSign\winCodeSign-2.6.0 - Source
See here.
This particular repo is a wrapper project for element-desktop, element-web, and matrix-js-sdk. It's the recommended starting point to build SchildiChat for Web and Desktop.
The master
branch contains the latest release.
Development happens in the sc
branch, which might be broken at any time!
schildichat-desktop <-- this repo (recommended starting point to build SchildiChat for Web and Desktop)
|-- element-desktop (electron wrapper)
|-- element-web (most of the development happens here)
`-- matrix-js-sdk (Matrix client js sdk)
Since Debian is usually slow to update packages on its stable releases,
some dependencies might not be recent enough to build SchildiChat.
The following are the dependencies required to build SchildiChat Web/Desktop on Debian 11 (bullseye):
# apt install vim curl git make gcc g++ python jq libsqlcipher-dev pkg-config libsecret-1-dev libarchive-tools openssl libssl-dev tcl
# curl -sL https://deb.nodesource.com/setup_16.x | bash -
# apt update
# apt install nodejs
# curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
# echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
# apt update
# apt install yarn
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
$ echo 'export PATH="$PATH:$HOME/.cargo/bin"' >> .bashrc
$ source .bashrc
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install tcl rust node gpg vim curl git yarn git make gcc
To sign a macOS build set the environment or make variable CSC_IDENTITY_AUTO_DISCOVERY
to true
or set CSC_NAME
to your certificate name or id.
To notarize a build with Apple set NOTARIZE_APPLE_ID
to your AppleID and set the keychain item
NOTARIZE_CREDS
to an App specific AppleID password.
# The single make targets are explained below
make {web|debian|windows-setup|windows-portable|macos|...}-release
After that these packages which belong to their respective make target should appear in release/<version>/.
web
: schildichat-web-<version>.tar.gz: Archive that can be unpacked and served by a web server (copyconfig.sample.json
toconfig.json
and adjust the configuration to your likings)debian
: File ready for installation on a Debian Linux (based) system viadpkg -i schildichat-desktop_<version>_amd64.deb
windows-setup
: SchildiChat_Setup_v<version>.exe: File ready for installation on a Windows systemwindows-portable
: SchildiChat_win-portable_v<version>.zip: Portable version for a Windows system – take SchildiChat together with your login data around with you (the archive contains a readme with instructions and notes)macos
: Build a *.dmg for macOS
pacman
: File ready for installation on an Arch Linux (based) system viapacman -U schildichat-desktop-<version>.pacman
rpm
: Build a *.rpm for Linuxwindows-unpacked
: SchildiChat_win-unpacked_v<version>.zip: unpacked archive for a Windows systemmacos-mas
: Build a *.pkg for release in the Mac App Store
Put the config.json
with the configuration you want for your hosted instance in a subfolder of the configs
folder.
Then create a file named release.mk
and fill it similar to that:
.PHONY: your-deploy-web
YOUR_CFGDIR := configs/your_subfolder
your-deploy-%: CFGDIR := $(YOUR_CFGDIR)
your-deploy-web: web
rsync --info=progress2 -rup --del element-web/webapp/ you@yourwebserver:/the/folder/served/for/schildi/
source merge_helpers.sh
forall_repos add_upstream