2022-07-12 20:25:24 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2020-10-22 20:57:28 +02:00
# ZeroNet for YunoHost
2020-11-12 19:50:50 +01:00
2022-07-12 20:25:24 +02:00
[](https://dash.yunohost.org/appci/app/zeronet)  
[](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
2022-07-12 20:25:24 +02:00
2020-11-12 19:45:22 +01:00
ZeroNet allows you to publish static and dynamic websites on a distributed web platform using Bitcoin crypto and the BitTorrent network.
2020-10-22 21:15:55 +02:00
2022-07-12 20:25:24 +02:00
**Shipped version:** 2021.01.25~ynh1
2020-10-22 21:15:55 +02:00
## Screenshots
2022-07-12 20:25:24 +02:00
2020-10-22 21:15:55 +02:00
2022-07-12 20:25:24 +02:00
## Disclaimers / important information
2020-10-22 21:15:55 +02:00
2020-11-12 19:45:22 +01:00
## Install instructions
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`.
2020-11-12 19:45:22 +01:00
- You can setup Tor which has to be done manually till its implimented in the app.[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
2020-11-12 19:45:22 +01:00
- Installing multiple instances of the app is *experimental* . Internally each instance will use an 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. But you try it and explain your user case.
2018-03-17 23:34:21 +01:00
- 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
## Limitations
2020-11-12 19:45:22 +01:00
* App can not be used inside SSO. See [here ](https://github.com/HelloZeroNet/ZeroNet/issues/2541 ) and [here ](https://github.com/YunoHost/issues/issues/1580 ).
2020-10-22 21:15:55 +02:00
2022-07-12 20:25:24 +02:00
## Documentation and resources
2020-10-22 20:57:28 +02:00
2022-07-12 20:25:24 +02:00
* Official app website: < https: // zeronet . io >
* Official admin documentation: < https: // zeronet . io / docs />
* Upstream app code repository: < https: // github . com / HelloZeroNet / ZeroNet >
* YunoHost documentation for this app: < https: // yunohost . org / app_zeronet >
* Report a bug: < https: // github . com / YunoHost-Apps / zeronet_ynh / issues >
2020-10-22 20:57:28 +02:00
## 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.
2022-07-12 20:25:24 +02:00
``` bash
2020-10-22 20:57:28 +02:00
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
```
2022-07-12 20:25:24 +02:00
**More info regarding app packaging:** < https: / / yunohost . org / packaging_apps >
