mirror of
https://github.com/YunoHost-Apps/seafile_ynh.git
synced 2024-09-03 20:26:01 +02:00
Refactor README
This commit is contained in:
Josué Tille
parent
d98ff01e86
commit
a0f115e379
1 changed files with 100 additions and 48 deletions
148
README.md
148
README.md
|
|
@ -1,66 +1,82 @@
|
|||
Seafile for Yunohost
|
||||
============
|
||||
Seafile For yunohost
|
||||
=================
|
||||
|
||||
[](https://ci-apps.yunohost.org/jenkins/job/seafile%20%28Community%29/lastBuild/consoleFull)
|
||||
[](https://install-app.yunohost.org/?app=seafile)
|
||||
|
||||
> *This package allow you to install seafile quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
Seafile is an open Source Cloud Storage application.
|
||||
|
||||
Official website: <http://seafile.com/>
|
||||
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.
|
||||
|
||||
[](https://ci-apps.yunohost.org/jenkins/job/seafile%20%28Community%29/lastBuild/consoleFull)
|
||||
**Shipped version:** 6.3.2
|
||||
|
||||
[](https://install-app.yunohost.org/?app=seafile)
|
||||
Screenshots
|
||||
-----------
|
||||
|
||||
Requirements
|
||||
------------
|
||||
| Cross Platform File Syncing | Mobile File Access | Seafile Drive client : a new nice way to work with your files | File Sharing and Permission Control |
|
||||
| :------------: | :------------: | :------------: | :------------: |
|
||||
|  |  |  |  |
|
||||
| Seafile organize files into libraries. Each library can be synced into any desktop computer, including Windows, Mac and Linux. User can also selectively sync any folder. Unsynced files can be accessed via a feature called “cloud file browser”. Seafile has a fantastic performance in file syncing. Tens of thousands of small files can be synced in a minute. | Access files via Seafile mobile clients. Both Android and iOS are supported. Cached files can be used offline without the network environment. Users can also backup photos and contacts via the mobile clients. | Seafile Drive client let users to extend the local disk space with the massive storage capacity on the Seafile server by mapping storage space on Seafile server as a virtual drive. User can access all files in Seafile immediately, without syncing them. Files can be used offline too. | Libraries and folders can be shared to users or groups, with read-only or read-write permissions. Finer-grained permissions can be set to sub-folders after a folder is shared. Files can be shared to external users via sharing links. Sharing links can be protected by passwords and support setting an expiration date. |
|
||||
|
||||
Functionnal instance of [Yunohost](https://yunohost.org/#/)
|
||||
| File Versioning and Snapshot | File locking | Online editing and co-authoring | Audit Log |
|
||||
| :------------: | :------------: | :------------: | :------------: |
|
||||
|  |  |  |  |
|
||||
| Seafile keeps versions for files and snapshots for folders. Users can restore a file or folder to an old version easily. Snapshot for folders is a handy way to protect files against ransomware. Using de-duplication technology, file versions are kept in an efficient way with reduced storage occupation. | Seafile supports file locking to prevent concurrent editing of files and generating of conflicts files. Users can lock files in web UI or desktop clients. Office files are automatically locked when they’re opened. | Seafile supports online editing and co-authoring for office files (including docx/pptx/xlsx) with integrating with Microsoft Office Online Server or Collabora Online server. Seafile also has a built-in preview for videos, audios, PDFs, images and text files. | Seafile has following logs to help you monitoring your system : Login log: Users'login log- Traffic log: Recording how much traffic is generated via sharing link for each user - Access log: file access log via syncing clients, mobiles clients and Web interface - Edit log: file editing/modification log - Permission log: logs for file access permission changes |
|
||||
|
||||
Installation
|
||||
------------
|
||||
Demo
|
||||
----
|
||||
|
||||
From command line:
|
||||
* [Official demo](https://demo.seafile.com/)
|
||||
|
||||
`sudo yunohost app install -l Seafile https://github.com/YunoHost-Apps/seafile_ynh`
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
Upgrade
|
||||
-------
|
||||
* Official documentation: https://manual.seafile.com/
|
||||
* YunoHost documentation: There no other documentations, feel free to contribute.
|
||||
|
||||
From command line:
|
||||
YunoHost specific features
|
||||
--------------------------
|
||||
|
||||
`sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/seafile_ynh`
|
||||
### Multi-users support
|
||||
|
||||
Infos
|
||||
-----
|
||||
This app support LDAP and the SSO authentification.
|
||||
|
||||
Seafile server v6.1.0
|
||||
The restriction is that the user ID in this app is an email adress. So it's potentially possible to have multiple user account with the same username. By example you can have `john@yunohost.org` and `john@seafile.org`. You can see the issue [#5](https://github.com/YunoHost-Apps/seafile_ynh/issues/5) wich describe this problem. You can check that you are not in this case if by going in seafile admin page in the user tab can see all account.
|
||||
|
||||
Available for x64, i386, and Raspberry Pi architecture but only tested for x64 (feedback are welcome)
|
||||
The best configuration is to give to each user an email which contains the domain used by seafile.
|
||||
|
||||
### Supported architectures
|
||||
|
||||
Since seafile 6.3 the i386 architecture is no more supported.
|
||||
|
||||
Seafile no longer distribute binary for generic armhf architectures but rpi binary could work.
|
||||
|
||||
/!\ To login use your yunohost email not your username.
|
||||
* x86-64b - [/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/seafile%20(Community)/)
|
||||
* ARMv8-A - [%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/seafile%20(Community)%20(%7EARM%7E)/)
|
||||
* Jessie x86-64b - [/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/seafile%20(Community)/)
|
||||
|
||||
Change URL
|
||||
----------
|
||||
<!--Limitations
|
||||
------------
|
||||
|
||||
Since now it's possible to change domain or the url of seafile but use it with precaution because it has not been tested enought for a big production installation. For the authentification and user every email for authentification will have the new domain name. For example `toto@old_domain.tld` will be `toto@new_domain.tld`.
|
||||
* Any known limitations.-->
|
||||
|
||||
Additional informations
|
||||
-----------------------
|
||||
|
||||
### Change URL
|
||||
|
||||
Since now it's possible to change domain or the url of seafile but use it with precaution because it has not been tested enough for a big production installation. For the authentication and user every email for authentication will have the new domain name. For example `toto@old_domain.tld` will be `toto@new_domain.tld`.
|
||||
|
||||
To do this run : `yunohost app change-url seafile -d new_domain.tld -p PATH new_path
|
||||
|
||||
License
|
||||
-------
|
||||
### Use a special user and put seafile binary in /opt dir :
|
||||
|
||||
Seafile server and its desktop clients are published under GPLv2.
|
||||
|
||||
Mobile clients are published under the GPLv3.
|
||||
|
||||
The Seafile server's web end, i.e. Seahub, is published under the Apache License.
|
||||
|
||||
This package is published under MIT License
|
||||
|
||||
Use a special user and put seafile binary in /opt dir :
|
||||
--------------------------------------
|
||||
|
||||
~~With this new package for a better security, it's possible to run seafile with a special user (seafile) put all seafile file in /opt/yunohost dir.~~
|
||||
In the new package version the install is by default in /opt dir, so it section is only usefull for user how as already installed seafile.
|
||||
|
||||
To do this open a console and do this command :
|
||||
|
|
@ -90,18 +106,54 @@ sudo service nginx reload
|
|||
sudo service seafile-server start
|
||||
```
|
||||
|
||||
Developper infos
|
||||
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:
|
||||
|
||||
`sudo yunohost app install -l seafile https://github.com/YunoHost-Apps/seafile_ynh`
|
||||
|
||||
Upgrade
|
||||
-------
|
||||
|
||||
From command line:
|
||||
|
||||
`sudo yunohost app upgrade seafile -u https://github.com/YunoHost-Apps/seafile_ynh`
|
||||
|
||||
Developers infos
|
||||
----------------
|
||||
|
||||
Please do your pull request to the Dev branch.
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/seafile_ynh/tree/testing).
|
||||
|
||||
Test or upgrade to dev version:
|
||||
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
|
||||
```
|
||||
su - admin
|
||||
git clone -b Dev https://github.com/YunoHost-Apps/seafile_ynh
|
||||
# to install
|
||||
sudo yunohost app install -l Seafile /home/admin/seafile_ynh
|
||||
# to upgrade
|
||||
sudo yunohost app upgrade -f /home/admin/seafile_ynh seafile
|
||||
|
||||
```
|
||||
License
|
||||
-------
|
||||
|
||||
Seafile server and its desktop clients are published under GPLv2.
|
||||
|
||||
Mobile clients are published under the GPLv3.
|
||||
|
||||
The Seafile server's web end, i.e. Seahub, is published under the Apache License.
|
||||
|
||||
This package is published under MIT License
|
||||
|
||||
TODO
|
||||
----
|
||||
|
||||
- Find a way to fix the issue https://github.com/YunoHost-Apps/seafile_ynh/issues/5
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue