Skip to content

Commit 193cbf6

Browse files
authored
Github pages and fixes
1 parent 5d041c0 commit 193cbf6

9 files changed

Lines changed: 71 additions & 20 deletions

docs/mura/ghp-about.png

4.69 KB
Loading

docs/mura/ghp-branch.png

32.1 KB
Loading

docs/mura/ghp-check.png

3.69 KB
Loading

docs/mura/ghp-fork.png

4.59 KB
Loading

docs/mura/ghp-pages.png

101 KB
Loading

docs/mura/github-pages.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: GitHub Pages
3+
parent: Mura (Frontend)
4+
nav_order: 2
5+
---
6+
7+
# GitHub Pages
8+
9+
How to host a free frontend instance using GitHub Pages
10+
11+
**1. Go to GitHub Mura repository**
12+
13+
[https://github.com/parley-chat/Mura](https://github.com/parley-chat/Mura)
14+
15+
{: .important }
16+
You need a GitHub account, if you don't have you create one.
17+
18+
**2. Fork the repository**
19+
20+
Press the "Fork" button.
21+
22+
![GitHub's fork button](ghp-fork.png)
23+
24+
and press the "Create fork" button, no settings need to be changed.
25+
26+
**3. Setup GitHub Pages**
27+
28+
Go to "Settings" then "Pages"
29+
30+
![GitHub's pages settings](ghp-pages.png)
31+
32+
Under "Branch" change "None" to "Main" and save.
33+
34+
![GitHub's branch settings](ghp-branch.png)
35+
36+
**4. Go to main repository page**
37+
38+
Go to the repository's main page and edit the about properties.
39+
40+
![GitHub's about setting button](ghp-about.png)
41+
42+
**5. Check "Use your GitHub Pages website"**
43+
44+
![Checkbox for using GitHub Pages url](ghp-check.png)
45+
46+
Save changes.
47+
48+
**6. Wait**
49+
50+
It should take about a minute, after it has correctly built the site just press the url under the "About" section.

docs/mura/node-run.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,13 @@ If npm is on the path but not node or node is several versions behind: install n
2525

2626
Go to a folder where you want the frontend folder to be and run:
2727
```bash
28-
git clone https://github.com/parley-chat/mura.git
28+
git clone https://github.com/parley-chat/Mura.git
29+
cd Mura
2930
```
3031

3132
## Running locally
3233

33-
Go to the frontend repo and run
34+
Once the frontend folder is there you just need to run this:
3435
```bash
3536
npm i express open
3637
node quickrun.js

docs/sova/development-installation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,40 @@ First, install Python using [Python Installation](python-installation.md)
1414

1515
## Installation Steps
1616

17-
1\. Create a directory for Parley Chat and navigate to it
17+
**1. Create a directory for Parley Chat and navigate to it**
1818

1919
```sh
2020
mkdir Parley-Chat
2121
cd Parley-Chat
2222
```
2323

24-
2\. Clone the Repository
24+
**2. Clone the Repository**
2525

2626
```sh
2727
git clone https://github.com/Parley-Chat/Sova.git
2828
```
2929

30-
3\. (Optional but recommended) Clone the Mura (Frontend) Repository
30+
**3. (Optional but recommended) Clone the Mura (Frontend) Repository**
3131

3232
To also host the Frontend with the Backend clone the Mura (Frontend) Repository:
3333
```sh
3434
git clone https://github.com/Parley-Chat/Mura.git
3535
```
3636

37-
4\. Navigate to Sova (Backend) Directory
37+
**4. Navigate to Sova (Backend) Directory**
3838

3939
```sh
4040
cd Sova
4141
```
4242

43-
5\. Install Dependencies
43+
**5. Install Dependencies**
4444

4545
Install the required Python packages:
4646
```sh
4747
pip install -r requirements.txt
4848
```
4949

50-
6\. Generate Configuration File
50+
**6. Generate Configuration File**
5151

5252
Run Parley Chat backend to create a config file:
5353
```sh
@@ -57,7 +57,7 @@ python3.13 main.py
5757
{: .note }
5858
Replace `python3.13` with `python` on Windows
5959

60-
7\. Configure the Backend
60+
**7. Configure the Backend**
6161

6262
Open `config.toml` with a text editor to configure the Backend:
6363

@@ -73,7 +73,7 @@ notepad config.toml
7373

7474
You can configure the Backend to run in debug mode using `dev=true` in the config file.
7575

76-
8\. Start the Server
76+
**8. Start the Server**
7777

7878
Run the following command to start the server:
7979

docs/sova/server-installation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ For development installation, use [Development Installation](development-install
1919

2020
## Installation Steps
2121

22-
1\. Create a directory for Parley Chat and navigate to it
22+
**1. Create a directory for Parley Chat and navigate to it**
2323

2424
```sh
2525
mkdir Parley-Chat
2626
cd Parley-Chat
2727
```
2828

29-
2\. Install Docker
29+
**2. Install Docker**
3030

3131
**Linux:**
3232
```sh
@@ -36,7 +36,7 @@ curl -sSL https://get.docker.com/ | bash
3636
{: .note }
3737
In restricted networks, use http_proxy and https_proxy environment variables to install Docker
3838

39-
3\. Clone the Repository
39+
**3. Clone the Repository**
4040

4141
```sh
4242
git clone https://github.com/Parley-Chat/Sova.git
@@ -45,20 +45,20 @@ git clone https://github.com/Parley-Chat/Sova.git
4545
{: .note }
4646
If `git` is not found, Install git on Ubuntu using: `apt install git`
4747

48-
4\. (Optional but recommended) Clone the Mura (Frontend) Repository
48+
**4. (Optional but recommended) Clone the Mura (Frontend) Repository**
4949

5050
To also host the Frontend with the Backend clone the Mura (Frontend) Repository:
5151
```sh
5252
git clone https://github.com/Parley-Chat/Mura.git
5353
```
5454

55-
5\. Navigate to Sova (Backend) Directory
55+
**5. Navigate to Sova (Backend) Directory**
5656

5757
```sh
5858
cd Sova
5959
```
6060

61-
6\. Create Configuration File
61+
**6. Create Configuration File**
6262

6363
Create an empty `config.toml` file (required for Docker to mount it as a file):
6464

@@ -72,14 +72,14 @@ touch config.toml
7272
type nul > config.toml
7373
```
7474

75-
7\. Generate Configuration
75+
**7. Generate Configuration**
7676

7777
Run Parley Chat backend to create a config file:
7878
```sh
7979
docker compose run --build --rm app
8080
```
8181

82-
8\. Configuration
82+
**8. Configuration**
8383

8484
Open `config.toml` with a text editor:
8585

@@ -102,7 +102,7 @@ If you have set a URI Prefix, you have to also set it in the `docker-compose.yml
102102
{: .important }
103103
It's highly recommended that you change the port in environments where internet censorship exists
104104

105-
9\. SSL Certificates
105+
**9. SSL Certificates**
106106

107107
{: .note }
108108
SSL certificates are **required** for production use. HTTP is unsupported due to WebCrypto API requirements. (localhost will still work normally on http)
@@ -113,7 +113,7 @@ Place your SSL certificates in the `certs` directory:
113113

114114
For detailed instructions on obtaining and configuring SSL certificates, including automatic setup with Let's Encrypt and certbot, see [SSL Certificates](ssl-certificates.md).
115115

116-
10\. Deploy
116+
**10. Deploy**
117117

118118
Start the services:
119119

0 commit comments

Comments
 (0)