Skip to content

Latest commit

 

History

History
189 lines (127 loc) · 6.89 KB

README.md

File metadata and controls

189 lines (127 loc) · 6.89 KB
Raw

SchildiChat Web/Desktop

SchildiChat Web/Desktop is a fork of Element Web/Desktop.

Initial build setup

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

Building on Linux

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

Windows building dependencies

To build on Windows, use Element's guide as starting point.

Some additional notes I found useful:

Before build

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)

Additional packages not mentioned upstream

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>

Troubleshooting

  • yarn link fails with permission denied: kill any running nodejs task
  • electron-builder fails to extract winCodeSign:
    • 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

Release builds

See here.

Old build instructions, to be revised in the future

Building SchildiChat Web/Desktop

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)

Install dependencies

Debian build dependencies

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

macOS build dependencies

Install brew package manager
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Install packages
brew install tcl rust node gpg vim curl git yarn git make gcc

Signed macOS builds

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.

Create release builds

# 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>/.

Builds distributed via GitHub releases

  • web: schildichat-web-<version>.tar.gz: Archive that can be unpacked and served by a web server (copy config.sample.json to config.json and adjust the configuration to your likings)
  • debian: File ready for installation on a Debian Linux (based) system via dpkg -i schildichat-desktop_<version>_amd64.deb
  • windows-setup: SchildiChat_Setup_v<version>.exe: File ready for installation on a Windows system
  • windows-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

Additional {...}-release targets not used for GitHub releases

  • pacman: File ready for installation on an Arch Linux (based) system via pacman -U schildichat-desktop-<version>.pacman
  • rpm: Build a *.rpm for Linux
  • windows-unpacked: SchildiChat_win-unpacked_v<version>.zip: unpacked archive for a Windows system
  • macos-mas: Build a *.pkg for release in the Mac App Store

Build SchildiChat Web and deploy it directly to your web server

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/

Merge helpers

Add upstream repo remotes

source merge_helpers.sh
forall_repos add_upstream