Blap README + curl-based release uploads
- Replace the element-web README with a Blap one (downloads/updating/building). - release-codeberg: upload assets via curl instead of Node fetch, which times out (UND_ERR_HEADERS_TIMEOUT) on 300MB+ files. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -1,117 +1,49 @@
|
||||
[](https://matrix.to/#/#element-web:matrix.org)
|
||||
|
||||
|
||||
[](https://localazy.com/p/element-web)
|
||||
[](https://sonarcloud.io/summary/new_code?id=element-web)
|
||||
[](https://sonarcloud.io/summary/new_code?id=element-web)
|
||||
[](https://sonarcloud.io/summary/new_code?id=element-web)
|
||||
[](https://sonarcloud.io/summary/new_code?id=element-web)
|
||||
# Blap
|
||||
|
||||
# Element
|
||||
A cozy, Discord-style social client for **[Matrix](https://matrix.org)**, built as a visual fork of
|
||||
[Element Web](https://github.com/element-hq/element-web). Same Matrix protocol, crypto, and calling —
|
||||
a rebuilt, voice-focused UI aimed at people coming from Discord.
|
||||
|
||||
Element (formerly known as Vector and Riot) is a Matrix web & desktop client built using the [Matrix
|
||||
JS SDK](https://github.com/matrix-org/matrix-js-sdk).
|
||||
## Download
|
||||
|
||||
# Supported Environments
|
||||
Latest build for your platform on the **[Releases page](https://codeberg.org/Enkisu/Blap/releases)**:
|
||||
|
||||
Element has several tiers of support for different environments:
|
||||
| Platform | File |
|
||||
|---|---|
|
||||
| Windows | `Blap Setup X.Y.Z.exe` |
|
||||
| Flatpak (Bazzite, etc.) | `Blap-X.Y.Z-x86_64.flatpak` |
|
||||
| Debian / Ubuntu | `blap_X.Y.Z_amd64.deb` |
|
||||
| Arch | `blap-X.Y.Z.pacman` |
|
||||
| Portable | `blap-X.Y.Z.tar.gz` |
|
||||
|
||||
- Supported
|
||||
- Definition:
|
||||
- Issues **actively triaged**, regressions **block** the release
|
||||
- Last 2 major versions of Chrome, Firefox, and Edge on desktop OSes
|
||||
- Last 2 versions of Safari
|
||||
- Latest release of official Element Desktop app on desktop OSes
|
||||
- Desktop OSes means macOS, Windows, and Linux versions for desktop devices
|
||||
that are actively supported by the OS vendor and receive security updates
|
||||
- Best effort
|
||||
- Definition:
|
||||
- Issues **accepted**, regressions **do not block** the release
|
||||
- The wider Element Products (including Element Call and the Enterprise Server Suite) do still not officially support these browsers.
|
||||
- The element web project and its contributors should keep the client functioning and gracefully degrade where other sibling features (E.g. Element Call) may not function.
|
||||
- Last major release of Firefox ESR and Chrome/Edge Extended Stable
|
||||
- Community Supported
|
||||
- Definition:
|
||||
- Issues **accepted**, regressions **do not block** the release
|
||||
- Community contributions are welcome to support these issues
|
||||
- Mobile web for current stable version of Chrome, Firefox, and Safari on Android, iOS, and iPadOS
|
||||
- Not supported
|
||||
- Definition: Issues only affecting unsupported environments are **closed**
|
||||
- Everything else
|
||||
## Updating
|
||||
|
||||
The period of support for these tiers should last until the releases specified above, plus 1 app release cycle(2 weeks). In the case of Firefox ESR this is extended further to allow it land in Debian Stable.
|
||||
- **Windows** updates itself in place (a "New update" prompt appears when a new version is out).
|
||||
- **Linux** can't self-update (owned by the package manager / flatpak sandbox), so Blap **notifies**
|
||||
you and you update with one command — see **[HOW-TO-UPDATE.md](./HOW-TO-UPDATE.md)**.
|
||||
|
||||
For accessing Element on an Android or iOS device, we currently recommend the
|
||||
native apps [element-x-android](https://github.com/element-hq/element-x-android)
|
||||
and [element-x-ios](https://github.com/element-hq/element-x-ios).
|
||||
## Building
|
||||
|
||||
# Getting Started
|
||||
Requires Node ≥ 22 and pnpm. From the repo root:
|
||||
|
||||
The easiest way to test Element is to just use the hosted copy at <https://app.element.io>.
|
||||
The `develop` branch is continuously deployed to <https://develop.element.io>
|
||||
for those who like living dangerously.
|
||||
```bash
|
||||
pnpm install
|
||||
# web bundle
|
||||
cd apps/web && pnpm run build
|
||||
# desktop (Blap variant) — Linux deb/flatpak/tar.gz + Windows exe
|
||||
cd ../desktop
|
||||
pnpm exec asar p ../web/webapp webapp.asar
|
||||
VARIANT_PATH=blap/build.json pnpm run build -- --linux --win
|
||||
```
|
||||
|
||||
To host your own instance of Element see [Installing Element Web](docs/install.md).
|
||||
Publishing a release (uploads the built artifacts to the Codeberg release):
|
||||
|
||||
To install Element as a desktop application, see [Running as a desktop app](#running-as-a-desktop-app) below.
|
||||
```bash
|
||||
CODEBERG_TOKEN=xxxx node apps/desktop/scripts/release-codeberg.mjs
|
||||
```
|
||||
|
||||
---
|
||||
## License & credits
|
||||
|
||||
# Monorepo
|
||||
|
||||
This repository is a monorepo hosting Element Web and other related projects in various subdirectories.
|
||||
You can read more about the structure [here](docs/monorepo.md).
|
||||
|
||||
# Element Web
|
||||
|
||||
To learn more about Element Web [click here](apps/web/README.md)
|
||||
|
||||
# Running as a Desktop app
|
||||
|
||||
Element can also be run as a desktop app, wrapped in Electron. You can download a
|
||||
pre-built version from <https://element.io/get-started> or, if you prefer,
|
||||
build it yourself.
|
||||
|
||||
To build it yourself, follow the instructions at <https://github.com/element-hq/element-web/tree/develop/apps/desktop>.
|
||||
|
||||
Many thanks to @aviraldg for the initial work on the Electron integration.
|
||||
|
||||
The [configuration docs](docs/config.md#desktop-app-configuration) show how to override the desktop app's default settings if desired.
|
||||
|
||||
# Development
|
||||
|
||||
Please read through the following:
|
||||
|
||||
1. [Developer guide](./developer_guide.md)
|
||||
2. [Code style](./code_style.md)
|
||||
3. [Contribution guide](./CONTRIBUTING.md)
|
||||
|
||||
# Translations
|
||||
|
||||
To add a new translation, head to the [translating doc](docs/translating.md).
|
||||
|
||||
For a developer guide, see the [translating dev doc](docs/translating-dev.md).
|
||||
|
||||
# Triaging issues
|
||||
|
||||
Issues are triaged by community members and the Web App Team, following the [triage process](https://github.com/element-hq/element-meta/wiki/Triage-process).
|
||||
|
||||
We use [issue labels](https://github.com/element-hq/element-meta/wiki/Issue-labelling) to sort all incoming issues.
|
||||
|
||||
## Copyright & License
|
||||
|
||||
Copyright (c) 2014-2017 OpenMarket Ltd
|
||||
Copyright (c) 2017 Vector Creations Ltd
|
||||
Copyright (c) 2017-2025 New Vector Ltd
|
||||
|
||||
This software is multi licensed by New Vector Ltd (Element). It can be used either:
|
||||
|
||||
(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
|
||||
|
||||
(2) for free under the terms of the GNU General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
|
||||
|
||||
(3) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
|
||||
Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
|
||||
|
||||
Please contact [licensing@element.io](mailto:licensing@element.io) to purchase
|
||||
an Element commercial license for this software.
|
||||
Blap is a fork of **element-web** (© New Vector Ltd and contributors) and keeps its
|
||||
**AGPL-3.0-only / GPL-3.0-only** licensing. This is an independent fork, not affiliated with or
|
||||
endorsed by Element.
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
* resolves to it (that's what the updater feed URL points at).
|
||||
*/
|
||||
import { readFile, readdir } from "node:fs/promises";
|
||||
import { statSync } from "node:fs";
|
||||
import { execFileSync } from "node:child_process";
|
||||
import { basename, join } from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
@@ -84,15 +86,27 @@ async function main() {
|
||||
method: "DELETE",
|
||||
});
|
||||
}
|
||||
const data = await readFile(join(distDir, file));
|
||||
const form = new FormData();
|
||||
form.append("attachment", new Blob([data]), name);
|
||||
const res = await fetch(
|
||||
`${API}/repos/${OWNER}/${REPO}/releases/${release.id}/assets?name=${encodeURIComponent(name)}`,
|
||||
{ method: "POST", headers: authHeaders, body: form },
|
||||
const filePath = join(distDir, file);
|
||||
const sizeMB = (statSync(filePath).size / 1e6).toFixed(0);
|
||||
process.stdout.write(`Uploading ${name} (${sizeMB} MB)... `);
|
||||
// Upload via curl: Node's built-in fetch (undici) times out on large files
|
||||
// (UND_ERR_HEADERS_TIMEOUT). curl streams from disk with no such limit.
|
||||
execFileSync(
|
||||
"curl",
|
||||
[
|
||||
"-sS",
|
||||
"--fail-with-body",
|
||||
"-X",
|
||||
"POST",
|
||||
"-H",
|
||||
`Authorization: token ${token}`,
|
||||
"-F",
|
||||
`attachment=@${filePath}`,
|
||||
`${API}/repos/${OWNER}/${REPO}/releases/${release.id}/assets?name=${encodeURIComponent(name)}`,
|
||||
],
|
||||
{ stdio: ["ignore", "ignore", "inherit"] },
|
||||
);
|
||||
if (!res.ok) throw new Error(`upload ${name} -> ${res.status} ${await res.text()}`);
|
||||
console.log(`Uploaded ${name}`);
|
||||
console.log("done");
|
||||
}
|
||||
|
||||
console.log(`\nDone. Updater feed: https://codeberg.org/${OWNER}/${REPO}/releases/latest/download/latest.yml`);
|
||||
|
||||
Reference in New Issue
Block a user