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

82 lines
3.4 KiB
Markdown
Raw Normal View History

2020-10-22 20:57:28 +02:00
# ZeroNet for YunoHost
2020-11-12 19:50:50 +01:00
2021-02-25 23:02:31 +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
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
**Shipped version:** 0.7.1
## Screenshots
2020-11-26 11:29:29 +01:00
![](https://camo.githubusercontent.com/7b79b9725df29fa5403ba490ff9870e0464a00e106bad5536867602625ca94cc/68747470733a2f2f692e696d6775722e636f6d2f4836304f4148592e706e67)
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
## 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
2020-11-12 19:45:22 +01:00
Are LDAP and HTTP auth supported? No
#### Android app (Still in beta)
[Android app](https://github.com/canewsin/zeronet_mobile)
2020-10-22 21:15:55 +02:00
#### Supported architectures
2021-02-08 19:54:55 +01:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/zeronet%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/zeronet/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/zeronet%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/zeronet/)
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
## Additional information
2020-11-12 19:45:22 +01:00
* Other info you would like to add about this Zeronet.
2020-10-22 21:15:55 +02:00
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
```