mirror of
https://github.com/YunoHost-Apps/zeronet_ynh.git
synced 2024-09-03 17:46:12 +02:00
80 lines
3.6 KiB
Markdown
80 lines
3.6 KiB
Markdown
# ZeroNet for YunoHost
|
|
[](https://dash.yunohost.org/appci/app/zeronet)  
|
|
[](https://install-app.yunohost.org/?app=zeronet)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install ZeroNet quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
eroNet allows you to publish static and dynamic websites on a distributed web platform.
|
|
|
|
**Shipped version:** 0.7.1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
* [Official demo](Link to a demo site for this app.)
|
|
|
|
## Install
|
|
- This app can only be installed on root path, i.e you will need to use a dedicated domain name, e.g.`zeronet.domain.tld`.
|
|
- The app is installed in private mode only so unauthenticated users can not temper with your content.
|
|
- If you want to be a proper ZeroNet peer (serving your and other's content) you will want to open TCP port 15441 in your firewall and make sure requests to this port reach your instance [do i need to have a port opened](https://zeronet.readthedocs.io/en/latest/faq/#do-i-need-to-have-a-port-opened)
|
|
- Alternatively you can setup Tor which has to be done manually [how to use zeronet with Tor](https://zeronet.readthedocs.io/en/latest/faq/#how-to-use-zeronet-with-tor)
|
|
|
|
## Multiple Instances
|
|
- Installing multiple instances of the app is *experimental*. Internally each instance it will use a unique port for both for ZeroNet UserInterface and FileServer. However, the tracker will see all instances as one peer, as they all use one and the same external IP address.
|
|
- A solution that hasn't been confirmed yet is to use Tor instead. Each instance should then have a unique external address.
|
|
|
|
## Documentation
|
|
|
|
* Official documentation: https://zeronet.io/docs/site_development/getting_started/
|
|
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
|
|
|
## YunoHost specific features
|
|
|
|
#### Multi-user support
|
|
|
|
Are LDAP and HTTP auth supported?
|
|
Can the app be used by multiple users?
|
|
|
|
#### Supported architectures
|
|
|
|
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
|
|
|
## Limitations
|
|
|
|
* Any known limitations.
|
|
|
|
## Additional information
|
|
|
|
* Other info you would like to add about this app.
|
|
|
|
**More info on the documentation page:**
|
|
https://yunohost.org/packaging_apps
|
|
|
|
|
|
## Links
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/zeronet_ynh/issues
|
|
* App website: https://zeronet.io/
|
|
* Upstream app repository: https://github.com/HelloZeroNet/ZeroNet
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
---
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
```
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade zeronet -u https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing --debug
|
|
```
|