Skip to content

Commit

Permalink
[deploy] Add multiple documents
Browse files Browse the repository at this point in the history
  - 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
Show file tree
Hide file tree
Showing 7 changed files with 304 additions and 14 deletions.
21 changes: 13 additions & 8 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,14 @@
* [Firewall settings](deploy/using_firewall.md)
* [Logrotate](deploy/using_logrotate.md)
* Other Deployment Issues
* [Add Memcached](deploy/add_memcached.md)
* [Deploy Seafile behind NAT](deploy/deploy_Seafile_behind_NAT.md)
* [Deploy Seahub at Non-root domain](deploy/deploy_Seahub_at_Non-root_domain.md)
* [Migrate From SQLite to MySQL](deploy/migrate_from_sqlite_to_mysql.md)
* [Add Memcached](deploy/add_memcached.md)
* [Deploy Seafile behind NAT](deploy/deploy_Seafile_behind_NAT.md)
* [Deploy Seahub at Non-root domain](deploy/deploy_Seahub_at_Non-root_domain.md)
* [Migrate From SQLite to MySQL](deploy/migrate_from_sqlite_to_mysql.md)
* [Common Problems for Setting up Server](deploy/common_problems_for_setting_up_server.md)
* [Deploy with Windows](deploy/deploy_with_windows.md)
* [Install Seafile Server as a Windows Service](deploy/install_seafile_server_as_a_windows_service.md)
* [Ports used by Seafile Windows Server](deploy/ports_used_by_seafile_windows_server.md)
* [Deploy Seafile Pro Edition]
* [Download and Setup Seafile Professional Server](deploy_pro/download_and_setup_seafile_professional_server.md)
* [Migrate from Seafile Community Server](deploy_pro/migrate_from_seafile_community_server.md)
Expand All @@ -32,14 +35,16 @@
* [Setup With Ceph](deploy_pro/setup_with_Ceph.md)
* [Configurable Options](deploy_pro/configurable_options.md)
* Other Deployment Issues
* [Use existing ElasticSearch server](deploy_pro/use_existing_ElasticSearch_server.md)
* [Details about File Search](deploy_pro/details_about_file_search.md)
* [Deploy in a cluster](deploy_pro/deploy_in_a_cluster.md)
* [Enable search and background tasks in a cluster](deploy_pro/enable_search_and_background_tasks_in_a_cluster.md)
* [Use existing ElasticSearch server](deploy_pro/use_existing_ElasticSearch_server.md)
* [Details about File Search](deploy_pro/details_about_file_search.md)
* [Deploy in a cluster](deploy_pro/deploy_in_a_cluster.md)
* [Enable search and background tasks in a cluster](deploy_pro/enable_search_and_background_tasks_in_a_cluster.md)
* [FAQ](deploy_pro/FAQ_for_seafile_pro_server.md)
* [Changelog](deploy_pro/changelog_for_seafile_pro_server.md)
* [License](deploy_pro/seafile_professional_sdition_software_license_agreement.md)
* [Server Configuration](deploy/server_configuration.md)
* [Seahub customization](deploy/seahub_customization.md)
* [Customize Email Notifications](deploy/customize_email_notifications.md)
* [WebDAV and FUSE extention]
* [Administration](maintain/README.md)
* [Seafile FSCK](maintain/seafile_fsck.md)
Expand Down
45 changes: 45 additions & 0 deletions deploy/customize_email_notifications.md
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

86 changes: 86 additions & 0 deletions deploy/deploy_with_windows.md
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)
30 changes: 30 additions & 0 deletions deploy/install_seafile_server_as_a_windows_service.md
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
73 changes: 73 additions & 0 deletions deploy/ports_used_by_seafile_windows_server.md
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
```
50 changes: 50 additions & 0 deletions deploy/seahub_customization.md
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`.
13 changes: 7 additions & 6 deletions deploy/server_configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Seafile
## Server Configuration

This manual explains how to change various config options for Seafile server. We assume that you've [[Download-and-setup-seafile-server|setup Seafile server]].
This manual explains how to change various config options for Seafile server. We
assume that you've [Download-and-setup-seafile-server](using_sqlite.md).

## Seafile Network Configurations (ccnet.conf)

Expand Down Expand Up @@ -39,7 +40,7 @@ PORT=13419

</pre>

'''Note''': You should restart seafile so that your changes take effect.
**Note**: You should restart seafile so that your changes take effect.

<pre>
cd seafile-server
Expand Down Expand Up @@ -88,7 +89,7 @@ max_upload_size=200
max_download_dir_size=200
</pre>

'''Note''': You need to restart seafile and seahub so that your changes take effect.
**Note**: You need to restart seafile and seahub so that your changes take effect.
<pre>
./seahub.sh restart
./seafile.sh restart
Expand Down Expand Up @@ -123,9 +124,9 @@ DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
SERVER_EMAIL = EMAIL_HOST_USER
</pre>

'''Note1''': If your Email service still can not work, you may checkout the log file <code>logs/seahub.log</code> to see what may cause the problem. For complete email notification list, please refer to [[Email notification list]].
**Note**: If your Email service still can not work, you may checkout the log file <code>logs/seahub.log</code> to see what may cause the problem. For complete email notification list, please refer to [Email notification list](customize_email_notifications.md).

'''Note2''': If you want to use the Email service without authentication leaf <code>EMAIL_HOST_USER</code> and <code>EMAIL_HOST_PASSWORD</code> '''blank''' (<code>''</code>). (But notice that the emails then will be sent without a <code>From:</code> address.)
**Note2**: If you want to use the Email service without authentication leaf <code>EMAIL_HOST_USER</code> and <code>EMAIL_HOST_PASSWORD</code> **blank** (<code>''</code>). (But notice that the emails then will be sent without a <code>From:</code> address.)

#### Cache

Expand Down Expand Up @@ -208,7 +209,7 @@ FORCE_SERVER_CRYPTO = True

</pre>

'''Note''':
**Note**:

* You need to restart seahub so that your changes take effect.
* If your changes don't take effect, You may need to delete 'seahub_setting.pyc'. (A cache file)
Expand Down

0 comments on commit 28a5a26

Please sign in to comment.