1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/zeronet_ynh.git synced 2024-09-03 17:46:12 +02:00
zeronet_ynh/README.md

81 lines
3.6 KiB
Markdown
Raw Normal View History

2020-10-22 20:57:28 +02:00
# ZeroNet for YunoHost
2020-11-09 13:27:06 +01:00
[![Integration level](https://dash.yunohost.org/integration/zeronet.svg)](https://dash.yunohost.org/appci/app/zeronet) ![](https://ci-apps.yunohost.org/ci/badges/zeronet.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/zeronet.maintain.svg)
[![Install ZeroNet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=zeronet)
2017-03-03 21:26:30 +01:00
2020-10-22 21:15:55 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2020-11-09 13:27:06 +01:00
> *This package allows you to install ZeroNet quickly and simply on a YunoHost server.
2020-10-22 21:15:55 +02:00
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
![](https://camo.githubusercontent.com/4629a7d44a828f5bb20cedd90522ae62f0947b35/68747470733a2f2f692e696d6775722e636f6d2f4836304f4148592e706e67)
## Demo
* [Official demo](Link to a demo site for this app.)
2017-03-03 21:26:30 +01:00
## Install
2020-03-29 13:38:30 +02:00
- 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`.
2018-03-17 15:40:36 +01:00
- 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)
2018-03-18 12:52:37 +01:00
- 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)
2018-03-17 23:34:21 +01:00
## 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.
2020-10-22 21:15:55 +02:00
## 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 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](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.
2020-11-09 13:27:06 +01:00
**More info on the documentation page:**
2020-10-22 21:15:55 +02:00
https://yunohost.org/packaging_apps
2020-10-22 20:57:28 +02:00
## 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
```