Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,64 +1,8 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
<p align="center">
|
| 10 |
-
<b>Ferron</b> - a fast, memory-safe web server written in Rust
|
| 11 |
-
</p>
|
| 12 |
-
<p align="center">
|
| 13 |
-
<a href="https://www.ferronweb.org/docs" target="_blank"><img alt="Static Badge" src="https://img.shields.io/badge/Documentation-orange"></a>
|
| 14 |
-
<a href="https://www.ferronweb.org" target="_blank"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fwww.ferronweb.org"></a>
|
| 15 |
-
<a href="https://x.com/ferron_web" target="_blank"><img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/ferron_web"></a>
|
| 16 |
-
<a href="https://hub.docker.com/r/ferronserver/ferron" target="_blank"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/ferronserver/ferron"></a>
|
| 17 |
-
<a href="https://github.com/ferronweb/ferron" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/ferronweb/ferron"></a>
|
| 18 |
-
</p>
|
| 19 |
-
|
| 20 |
-
* * *
|
| 21 |
-
|
| 22 |
-
## Features
|
| 23 |
-
|
| 24 |
-
- **High performance** - built with Rust’s async capabilities for optimal speed.
|
| 25 |
-
- **Memory-safe** - built with Rust, which is a programming language offering memory safety.
|
| 26 |
-
- **Extensibility** - modular architecture for easy customization.
|
| 27 |
-
- **Secure** - focus on robust security practices and safe concurrency.
|
| 28 |
-
|
| 29 |
-
## Components
|
| 30 |
-
|
| 31 |
-
Ferron consists of multiple components:
|
| 32 |
-
|
| 33 |
-
- **`ferron`**: The main web server.
|
| 34 |
-
- **`ferron-passwd`**: A tool for generating user entries with hashed passwords, which can be copied into the web server's configuration file.
|
| 35 |
-
|
| 36 |
-
## Building Ferron from source
|
| 37 |
-
|
| 38 |
-
You can clone the repository and explore the existing code:
|
| 39 |
-
|
| 40 |
-
```sh
|
| 41 |
-
git clone https://github.com/ferronweb/ferron.git
|
| 42 |
-
cd ferron
|
| 43 |
-
```
|
| 44 |
-
|
| 45 |
-
You can then build and run the web server using Cargo:
|
| 46 |
-
|
| 47 |
-
```sh
|
| 48 |
-
cargo build -r
|
| 49 |
-
cargo run -r --bin ferron
|
| 50 |
-
```
|
| 51 |
-
|
| 52 |
-
You can also use [Ferron Forge](https://github.com/ferronweb/ferron-forge) to build the web server. Ferron Forge outputs a ZIP archive that can be used by the Ferron installer.
|
| 53 |
-
|
| 54 |
-
## Server configuration
|
| 55 |
-
|
| 56 |
-
You can check the [Ferron documentation](https://www.ferronweb.org/docs/configuration) to see configuration properties used by Ferron.
|
| 57 |
-
|
| 58 |
-
## Contributing
|
| 59 |
-
|
| 60 |
-
See [Ferron contribution page](https://www.ferronweb.org/contribute) for details.
|
| 61 |
-
|
| 62 |
-
## License
|
| 63 |
-
|
| 64 |
-
Ferron is licensed under the MIT License. See `LICENSE` for details.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
title: Webb
|
| 4 |
+
sdk: docker
|
| 5 |
+
emoji: 🏆
|
| 6 |
+
colorFrom: green
|
| 7 |
+
colorTo: purple
|
| 8 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|