|
2 | 2 | <img src="icon.png" alt="Project Logo" width="21%"> |
3 | 3 | </p> |
4 | 4 |
|
5 | | -# Synapse for StartOS |
| 5 | +## Building from source |
6 | 6 |
|
7 | | -[Synapse](https://github.com/matrix-org/synapse) is a homeserver software for the Matrix protocol, enabling decentralized and federated communication across different Matrix servers to send messages and interact with each other seamlessly. This repository creates the `s9pk` package that is installed to run `Synapse` with integrated [`Admin UI`](https://github.com/etkecc/synapse-admin) on [StartOS](https://github.com/Start9Labs/start-os/). |
| 7 | +1. Set up your [environment](https://docs.start9.com/packaging-guide/environment-setup.html). |
8 | 8 |
|
9 | | -## Dependencies |
| 9 | +1. Clone this repository and `cd` into it. |
10 | 10 |
|
11 | | -Prior to building the `synapse.s9pk` package, it's essential to configure your build environment for StartOS services. You can find instructions on how to set up the appropriate build environment in the [Packaging Guide](https://staging.docs.start9.com/packaging-guide/). |
| 11 | +1. run `make`. |
12 | 12 |
|
13 | | -- [docker](https://docs.docker.com/get-docker) |
14 | | -- [docker-buildx](https://docs.docker.com/buildx/working-with-buildx/) |
15 | | -- [make](https://www.gnu.org/software/make/) |
16 | | -- [start-cli](https://github.com/Start9Labs/start-cli/) |
| 13 | +1. The resulting `.s9pk` can be side loaded into StartOS. |
17 | 14 |
|
18 | | -## Cloning |
19 | | - |
20 | | -Clone the Synapse package repository locally. |
21 | | - |
22 | | -``` |
23 | | -git clone https://github.com/Start9Labs/synapse-startos.git |
24 | | -cd synapse-startos |
25 | | -``` |
26 | | - |
27 | | -## Building |
28 | | - |
29 | | -To build the **Synapse** service as a universal package, run the following command: |
30 | | - |
31 | | -``` |
32 | | -make |
33 | | -``` |
34 | | - |
35 | | -## Installing (on StartOS) |
36 | | - |
37 | | -Before installation, define `host: https://server-name.local` in your `~/.startos/config.yaml` config file then run the following commands to determine successful install: |
38 | | - |
39 | | -> :information_source: Change server-name.local to your Start9 server address |
40 | | -
|
41 | | -``` |
42 | | -make install |
43 | | -``` |
44 | | - |
45 | | -**Tip:** You can also install the `synapse.s9pk` by using the **Sideload** tab available in the top menu of the StartOS UI. |
46 | | - |
47 | | -## Verify Install |
48 | | - |
49 | | -Go to your StartOS Services page, select **Synapse**, configure and start the service. |
50 | | - |
51 | | -**Done!** |
| 15 | +For a complete list of build options, see the [docs](https://docs.start9.com/packaging-guide/building.html) |
0 commit comments