mirror of
https://github.com/YunoHost-Apps/seafile_ynh.git
synced 2024-09-03 20:26:01 +02:00
159 lines
5.7 KiB
Markdown
159 lines
5.7 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# Seafile for YunoHost
|
|
|
|
[![Integration level](https://dash.yunohost.org/integration/seafile.svg)](https://dash.yunohost.org/appci/app/seafile) ![Working status](https://ci-apps.yunohost.org/ci/badges/seafile.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/seafile.maintain.svg)
|
|
|
|
[![Install Seafile with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=seafile)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Seafile 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
|
|
|
|
Seafile is an open Source Cloud Storage application.
|
|
|
|
It's a Enterprise file sync and share platform with high reliability and performance. It's a file hosting platform with high reliability and performance. Put files on your own server. Sync and share files across different devices, or access all the files as a virtual disk.
|
|
|
|
|
|
**Shipped version:** 9.0.2~ynh2
|
|
|
|
**Demo:** https://demo.seafile.com
|
|
|
|
## Screenshots
|
|
|
|
![Screenshot of Seafile](./doc/screenshots/mobile-ios-client.jpg)
|
|
![Screenshot of Seafile](./doc/screenshots/drive-client.png)
|
|
![Screenshot of Seafile](./doc/screenshots/file-locking.jpg)
|
|
![Screenshot of Seafile](./doc/screenshots/access-logs.jpg)
|
|
![Screenshot of Seafile](./doc/screenshots/file-history.png)
|
|
![Screenshot of Seafile](./doc/screenshots/wiki_en.png)
|
|
![Screenshot of Seafile](./doc/screenshots/sharing-dialog.png)
|
|
![Screenshot of Seafile](./doc/screenshots/sync-client.jpg)
|
|
|
|
## Disclaimers / important information
|
|
|
|
### Multi-users support
|
|
|
|
This app support LDAP and the SSO authentification.
|
|
|
|
If you have Seafile installed before 7.x and you have more than one domain for users in Yunohost or Seafile app is installed on a different domain, you need to migrate your accounts.
|
|
You can use the provided action at https://domain.tld/yunohost/admin/#/apps/seafile/actions. You can also use this following command to migrate all of your accounts:
|
|
```
|
|
yunohost app action run seafile migrate_user_email_to_mail_email
|
|
```
|
|
See [issue#44](https://github.com/YunoHost-Apps/seafile_ynh/issues/44)
|
|
for more information.
|
|
|
|
### Supported architectures
|
|
|
|
Since seafile 6.3 the i386 architecture is no more supported.
|
|
|
|
Seafile don't distribute binary for generic armhf architectures but rpi binary generally work on all arm board.
|
|
|
|
<!--Limitations
|
|
------------
|
|
|
|
* Any known limitations.-->
|
|
|
|
Additional informations
|
|
-----------------------
|
|
|
|
### Links
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/seafile_ynh/issues
|
|
* App website: https://www.seafile.com
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
---
|
|
|
|
### Install
|
|
|
|
From command line:
|
|
|
|
`yunohost app install seafile`
|
|
|
|
### Upgrade
|
|
|
|
By default a backup is made before the upgrade. To avoid this you have theses following possibilites:
|
|
- Pass the `NO_BACKUP_UPGRADE` env variable with `1` at each upgrade. By example `NO_BACKUP_UPGRADE=1 yunohost app upgrade synapse`.
|
|
- Set the settings `disable_backup_before_upgrade` to `1`. You can set this with this command:
|
|
|
|
`yunohost app setting synapse disable_backup_before_upgrade -v 1`
|
|
|
|
After this settings will be applied for **all** next upgrade.
|
|
|
|
From command line:
|
|
|
|
`yunohost app upgrade seafile`
|
|
|
|
### Backup
|
|
|
|
This app use now the core-only feature of the backup. To keep the integrity of the data and to have a better guarantee of the restoration is recommended to proceed like this:
|
|
|
|
- Stop seafile service with theses following command:
|
|
|
|
`systemctl stop seafile.service seahub.service`
|
|
|
|
- Launch the backup of seafile with this following command:
|
|
|
|
`yunohost backup create --app seafile`
|
|
|
|
- Do a backup of your data with your specific strategy (could be with rsync, borg backup or just cp). The data is stored in `/home/yunohost.app/seafile-data`.
|
|
- Restart the seafile service with theses command:
|
|
|
|
`systemctl start seafile.service seahub.service`
|
|
|
|
### Remove
|
|
|
|
Due of the backup core only feature the data directory in `/home/yunohost.app/seafile-data` **is not removed**. It need to be removed manually to purge app user data.
|
|
|
|
### Change URL
|
|
|
|
Since now it's possible to change domain or the url of seafile.
|
|
|
|
To do this run : `yunohost app change-url seafile -d new_domain.tld -p PATH new_path`
|
|
|
|
Developers infos
|
|
----------------
|
|
|
|
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/seafile_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
```
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/seafile_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade seafile -u https://github.com/YunoHost-Apps/seafile_ynh/tree/testing --debug
|
|
```
|
|
|
|
TODO
|
|
----
|
|
|
|
- Find a way to fix the issue https://github.com/YunoHost-Apps/seafile_ynh/issues/5
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://www.seafile.com>
|
|
* Official admin documentation: <https://manual.seafile.com>
|
|
* Upstream app code repository: <https://github.com/haiwen/seafile-server>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_seafile>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/seafile_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/seafile_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/seafile_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade seafile -u https://github.com/YunoHost-Apps/seafile_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|