Skip to content

Commit 91dcc7a

Browse files
Update README.md
1 parent 1070c49 commit 91dcc7a

1 file changed

Lines changed: 7 additions & 48 deletions

File tree

README.md

Lines changed: 7 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -31,41 +31,13 @@ When a new Element Web release is detected:
3131

3232
The processed Element Web files are available in the `processed/` directory. Deploy them to your Apache web server as you would normally deploy Element Web.
3333

34-
### Apache Configuration Example
34+
1. backup your config.json file
35+
2. Clone this repository to your hosting / server
36+
3. create a symlink to the /processed folder to serve the application
37+
4. whenever there's a new release, run git pull on your hosting / server
38+
5. copy your config.json file back into the processed folder
3539

36-
```apache
37-
<VirtualHost *:443>
38-
ServerName element.example.com
39-
40-
DocumentRoot /var/www/element-web
41-
42-
<Directory /var/www/element-web>
43-
Options -Indexes +FollowSymLinks
44-
AllowOverride None
45-
Require all granted
46-
</Directory>
47-
48-
# SSL configuration
49-
SSLEngine on
50-
SSLCertificateFile /path/to/cert.pem
51-
SSLCertificateKeyFile /path/to/key.pem
52-
</VirtualHost>
53-
```
54-
55-
## Manual Processing
56-
57-
To manually process a specific Element Web release:
58-
59-
```bash
60-
# Download and extract Element Web
61-
curl -L https://github.com/element-hq/element-web/releases/download/v1.12.0/element-v1.12.0.tar.gz -o element-web.tar.gz
62-
tar -xzf element-web.tar.gz
63-
64-
# Run the rename script
65-
./scripts/rename.sh ./element-v1.12.0 ./processed
66-
```
67-
68-
## How It Works
40+
## How the search / replace script works
6941

7042
The `scripts/rename.sh` script:
7143
1. Copies the source files to the destination directory
@@ -75,19 +47,6 @@ The `scripts/rename.sh` script:
7547
3. Updates `index.html` icon references
7648
4. Renames the physical `icons/` directory to `ui-icons/`
7749

78-
## Repository Structure
79-
80-
```
81-
.
82-
├── .github/
83-
│ └── workflows/
84-
│ └── sync-element-web.yml # Automated sync workflow
85-
├── processed/ # Processed Element Web files
86-
├── scripts/
87-
│ └── rename.sh # Icon path renaming script
88-
└── current-release.txt # Tracks the current version
89-
```
90-
9150
## License
9251

93-
This repository contains automation scripts and workflows. The Element Web application itself is licensed under the Apache License 2.0. See the [Element Web repository](https://github.com/element-hq/element-web) for details.
52+
This repository contains automation scripts and workflows and is licensed under **AGPL-3.0**. The `processed/` folder contains files from [element-web](https://github.com/element-hq/element-web) and remains licensed under **AGPL** according to the upstream license.

0 commit comments

Comments
 (0)