# SchildiChat Web/Desktop Lite SchildiChat Web/Desktop is a fork of Element [Web](https://github.com/vector-im/element-web)/[Desktop](https://github.com/vector-im/element-desktop). This branch builds the "lite" variant, which rebases a reduced feature set of the original fork on top of the latest Element, in order to keep maintenance effort more manageable while staying up-to-date. For bringup I'm currently trying out a new approach which relies less on merges but rather on cherry-picking our changes back. So while the old build instructions mostly still apply, you need to do some new steps: After cloning, add usptream remotes: ``` source merge_helpers.sh forall_repos add_upstream ``` Then, to checkout the latest upstream release and pick our changes on top of it (I know the script name isn't accurate right now) ``` ./merge_upstream.sh ``` Note that `./merge_upstream.sh` may pick up a wrong tag right now, e.g. a release candidate instead of the latest build, which may cause problems if you plan to develop on top of it. If you want to build against a specific Element version rather than the latest (e.g. v1.11.66): ``` ./merge_upstream.sh v1.11.66 ``` If there are conflicts picking some changes running this script, solve them manually. If you want to persist a new set of patches in `schildichat-desktop`, run ``` ./generate_patches.sh ``` Note this script may be broken right now when not run against actual element releases (it was causing issues for a release candidate for sure). ## 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, matrix-react-sdk 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 ("skin" for matrix-react-sdk)
|-- matrix-react-sdk (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. ### Initial setup As already noted above, **`master` contains the latest release** and **`sc` is the development branch**! ``` 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 ``` ### 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/\/. #### Builds distributed via GitHub releases - `web`: _schildichat-web-\.tar.gz_: Archive that can be unpacked and served by a **web** server (copy `config.sample.json` to `config.json` and adjust the [configuration](https://github.com/SchildiChat/element-web/blob/sc/docs/config.md) to your likings) - `debian`: File ready for installation on a **Debian Linux** (based) system via `dpkg -i schildichat-desktop__amd64.deb` - `windows-setup`: _SchildiChat_Setup_v\.exe_: File ready for **installation** on a **Windows** system - `windows-portable`: _SchildiChat_win-portable_v\.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-.pacman` - `rpm`: Build a *.rpm for Linux - `windows-unpacked`: _SchildiChat_win-unpacked_v\.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](https://github.com/SchildiChat/element-web/blob/sc/docs/config.md) 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 ```