-
Notifications
You must be signed in to change notification settings - Fork 117
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- add customize email notifications - add deploy with windows - add install seafile server as a windows service - add ports used by seafile windows server - add seahub customization - several improvement in previous documents - fix code indent in SUMMARY.md
- Loading branch information
Chilledheart
committed
Jul 8, 2014
1 parent
7aa2847
commit 28a5a26
Showing
7 changed files
with
304 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Seafile | ||
## Customize Email Notifications | ||
|
||
**Note:** Subject line may vary between different releases, this is based on Release 2.0.1. Restart Seahub so that your changes take effect. | ||
|
||
## User reset his/her password ## | ||
|
||
**Subject** | ||
|
||
seahub/seahub/auth/forms.py line:103 | ||
|
||
**Body** | ||
|
||
seahub/seahub/templates/registration/password_reset_email.html | ||
|
||
## System admin add new member ## | ||
|
||
**Subject** | ||
|
||
seahub/seahub/views/sysadmin.py line:424 | ||
|
||
**Body** | ||
|
||
seahub/seahub/templates/sysadmin/user_add_email.html | ||
|
||
## System admin reset user password ## | ||
|
||
**Subject** | ||
|
||
seahub/seahub/views/sysadmin.py line:368 | ||
|
||
**Body** | ||
|
||
seahub/seahub/templates/sysadmin/user_reset_email.html | ||
|
||
## User send file/folder share link ## | ||
|
||
**Subject** | ||
|
||
seahub/seahub/share/views.py line:668 | ||
|
||
**Body** | ||
|
||
seahub/seahub/templates/shared_link_email.html | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Seafile | ||
## Deploy with Windows | ||
|
||
## Download/Uncompress | ||
###Install Python 2.7 | ||
|
||
- Download and install [python 2.7](https://www.python.org/ftp/python/2.7.8/python-2.7.8.msi) | ||
- Add the installation path of python2.7 to the system PATH environment variable. If you installed python 2.7 to ``C:\Python27`` add ``C:\Python27`` to the PATH environment variable | ||
|
||
### Download/Uncompress Seafile Server | ||
|
||
- Get the latest version of Seafile Server program | ||
- Create a new folder to store seafile program, such as ``C:\SeafileProgram\``. Please remember the location of the folder, we'll use it later. | ||
- Uncompress ``seafile-server_1.7.0_win32.tar.gz`` to ``C:\SeafileProgram\`` | ||
|
||
Now you have a folder like this: | ||
```sh | ||
C:\SeafileProgram | ||
|__ seafile-server-1.7.0 | ||
``` | ||
##Start/Initialization | ||
|
||
###Start Seafile Server | ||
|
||
Go to the folder ``C:\SeafileProgram\seafile-server-1.7.0\``, and double click run.bat to start Seafile Server. You should notice a seafile icon appears in the system tray. | ||
Choose a disk to store Seafile Server data | ||
|
||
Now you'll be prompted a dialog to choose a disk to store the data of seafile server | ||
|
||
- Please choose a disk with enough free space | ||
- Once you clicked the OK button, Seafile would create a folder named seafile-server under the disk you choosed. That would be the data folder of Seafile Server. If you choose disk D, your data folder would be ``D:\seafile-server`` | ||
|
||
###Add an admin account | ||
|
||
Right click the tray icon of Seafile Server, choose __Add an admin__. Input your admin username and password in the prompted dialog. | ||
|
||
If the operation is successful, the tray icon would show a bubble saying __Successully added the admin acount__ | ||
###Configure Seafile Server | ||
|
||
After initialization, there are some options need to be configured: | ||
|
||
- Right click the tray icon, choose __Open seafile-server folder__. Your seafile-server data folder would be opened. | ||
- Edit the file ``ccnet/ccnet.conf``. Modify two lines of ``ccnet.conf``: | ||
``` | ||
NAME = XXXXX | ||
SERVICE_URL = XXX | ||
``` | ||
- Change the value of NAME to the name of your Seafile Server, such as NAME = my-company-seafile. This name would be displayed on your seafile clients | ||
- Change the value of ``SERVICE_URL`` to ``http://<your ip address>:8000``. Say the ip address of your windows server is 192.168.1.100, then change it to ``SERVICE_URL = http://192.168.1.100:8000`` | ||
|
||
After the edit, right click tray icon, choose __Restart seafile__ | ||
###Visit Seahub | ||
|
||
Open your browser, and visit ``http://127.0.0.1:8000``. Login with the admin account. If you can login, the initialization is successful. | ||
Configuration done | ||
|
||
Seafile Server configuration is finished. See Seafile Client Manual for how to use the client | ||
|
||
|
||
##Common Issues | ||
|
||
If you failed to set up Seafile server, first check seafserv-applet.log. | ||
###"ERROR: D:/seafile-server\seahub.db not found" | ||
|
||
This file is created during Seafile initialization. Please: | ||
|
||
- Check whether your Python and the ``PATH`` for Python is correctly set. | ||
- Put Seafile server package in a simple path, like ``C:\seafile-packages``. | ||
|
||
###Failed to create seahub.db | ||
|
||
Use python version 2.7.x, do not use python 3+. | ||
###Can not upload/download files in the Web interface | ||
|
||
Make sure you have modified ``SERVICE_URL`` in ccnet.conf. | ||
The browser can't get the css and javascript files | ||
|
||
- Use python 2.7.x. If you have installed other python version, uninstall it and install python 2.7.x. Restart seafile server to see whether the problem has gone. | ||
- Delete non-ASCII keys from the registry path ``HKEY_CLASSES_ROOT\MIME\Database\Content`` Type, and try again. | ||
|
||
|
||
###You may also want to read about: | ||
|
||
- [Install Seafile Server as a Windows Service](install_seafile_server_as_a_windows_service.md) | ||
- [LDAP Integration](using_ldap.md) | ||
- [Ports used by Seafile Windows Server](ports_used_by_seafile_windows_server.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Seafile | ||
## Install Seafile Server as a Windows Service | ||
|
||
###Why you may want to install Seafile Server as a Windows service | ||
|
||
- Seafile Server can keep on running after all users logout | ||
- When system boots up, Seafile Server would start running even if no user has logged in | ||
|
||
###Install as a service | ||
|
||
- Right click the tray icon, choose __Install as a Windows service__ | ||
- Choose ``yes`` in the propmted dialog | ||
|
||
If the operation succeeds, A dialog would be prompted saying __Successully installed seafile service__. | ||
###Verify Seafile Server already running as a Windows service | ||
|
||
- Logout the current user | ||
- Visit seahub from another computer. If the seahub website can still be visited, Seafile server is already running as a Windows server | ||
|
||
###How to start the tray icon after installing as a service | ||
|
||
If you have installed seafile server as a service, it would run automatically in the background the next time you boot your system. However, the tray icon would not appear automatically when a user logins in. | ||
|
||
To start the tray icon, just doule click the ``run.bat`` file in the folder ``C:\SeafileProgram\seafile-server-1.7.0`` | ||
Uninstall Seafile Server Windows service | ||
|
||
###If you want to uninstall the Seafile Server service: | ||
|
||
- Right click the tray icon, choose "Uninstall Windows service" | ||
- Choose "yes" in the propmted dialog |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Seafile | ||
## Ports used by Seafile Windows Server | ||
|
||
Seafile server has several components, so several TCP ports are used. | ||
##The two configuration files | ||
|
||
All ports related configuration are recorded in ``ccnet.conf`` and ``seafile.conf``. | ||
###How to open ``ccnet.conf`` | ||
|
||
- Right click the seafile server trayicon, choose __Open seafile-server folder__ | ||
- Open the folder ``ccnet`` under ``seafile-server`` folder. The file ``ccnet.conf`` is there. | ||
|
||
###How to open ``seafile.conf`` | ||
|
||
- Right click the seafile server trayicon, choose __Open seafile-server folder__ | ||
- Open the folder ``seafile-data`` under ``seafile-server`` folder. The file ``seafile.conf`` is there. | ||
|
||
In the following section we list the TCP ports used by each of seafile components, as well as how to change them (For example, some port may have already been used by some other application). | ||
|
||
**Note**: If you change any of the ports, you have to restart seafile server. | ||
##ccnet | ||
|
||
ccnet is the networking service for seafile server | ||
|
||
- default: 10001 | ||
- How to change: Edit the file ccnet.conf. Change the value of PORT under the Network section. | ||
|
||
``` | ||
[Network] | ||
PORT = 10001 | ||
``` | ||
##seaf-server | ||
|
||
seaf-server provides the data service for seafile server | ||
|
||
- default: 12001 | ||
- How to change: Edit the file ``seafile.conf``. Change the value of port under the network section. | ||
|
||
|
||
``` | ||
[network] | ||
port=22001 | ||
``` | ||
###seafile httpserver | ||
|
||
seafile httpserver handles raw file upload/download for Seahub | ||
|
||
- default: 8082 | ||
- How to change: Edit the file ``seafile.conf``. Change the value of port under the httpserver section. | ||
|
||
``` | ||
[httpserver] | ||
port=8082 | ||
``` | ||
###seahub | ||
|
||
seahub is the web interface of seafile server. | ||
|
||
**Note**: If you change the port of seahub, you need to change the ``SERVICE_URL`` in ``ccnet.conf``. | ||
|
||
- default: 8000 | ||
- How to change: Edit the file ``seafile.conf``. Change the value of port under the seahub section. (This is added in Seafile Windows Server 1.7.0.1) | ||
|
||
``` | ||
[seahub] | ||
port=8000 | ||
``` | ||
- Edit the file ``ccnet.conf``, modify the value of ``SERVICE_URL`` accordingly. For example, if you have changed the port to 8001, then modify the value of ``SERVICE_URL`` accordingly: | ||
|
||
``` | ||
[General] | ||
SERVICE_URL = <Your IP OR DOMAIN>:8001 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Seafile | ||
## Seahub customization | ||
## Customize Seahub Logo and Css | ||
|
||
Assume that you are using version 2.1.0. Create a folder `custom` under `seafile-server-2.1.0/seahub/media`. Put all the customization files here. The upgrade script will copy the folder to `seafile-server-2.1.1/seahub/media` when you upgrade to version 2.1.1. | ||
|
||
### Customize Logo | ||
|
||
1. Add your logo file to `seahub/media/custom/` | ||
2. Overwrite `LOGO_PATH` in `seahub_settings.py` | ||
|
||
<pre> | ||
LOGO_PATH = 'custom/mylogo.png' | ||
</pre> | ||
|
||
3. Overwrite `LOGO_URL` in `seahub_settings.py` | ||
|
||
<pre> | ||
LOGO_URL = 'http://your-seafile.com' | ||
</pre> | ||
|
||
### Customize Seahub CSS | ||
|
||
1. Add your css file to `seahub/media/custom/`, for example, `custom.css` | ||
2. Overwrite `BRANDING_CSS` in `seahub_settings.py` | ||
|
||
<pre> | ||
BRANDING_CSS = 'custom/custom.css' | ||
</pre> | ||
|
||
## Customize footer and other Seahub Pages | ||
|
||
**Note:** Since version 2.1. | ||
|
||
Create a foler ``templates`` under ``<seafile-install-path>/seahub-data/custom`` | ||
|
||
### Customize footer | ||
|
||
1. Copy ``seahub/seahub/templates/footer.html`` to ``seahub-data/custom/templates``. | ||
2. Modify `footer.html`. | ||
|
||
### Customize Download page | ||
|
||
1. Copy ``seahub/seahub/templates/download.html`` to ``seahub-data/custom/templates``. | ||
2. Modify `download.html`. | ||
|
||
### Customize Help page | ||
|
||
1. Copy ``seahub/seahub/help/templates/help`` to ``seahub-data/custom/templates/help``. | ||
2. Modify pages under `help`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters