Commit c989e8e0 authored by Dmitry Shelepnev's avatar Dmitry Shelepnev
Browse files

Update README.md

parent 21eb78da
Loading
Loading
Loading
Loading
+17 −13
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@
- Django 1.9 (для Python 3.3 необходимо устанавливать Django 1.8: https://code.djangoproject.com/ticket/25868)
- Pillow 2.9.0
- apscheduler 3.3.0
- django-constance[database] 1.3

Для работы проекта необходимо установить указанные  зависимости: 

@@ -34,14 +35,14 @@

	python3 manage.py createsuperuser
	
1.6 Настраиваем путь к Вашему каталогу с книгами (Однако Вы можете сначала запустить sopds_server согласно п.1.8. и настроить указанный параметр через веб-интерфейс)
1.6 Настраиваем путь к Вашему каталогу с книгами

	python3 manage.py sopds_util setconf SOPDS_ROOT_LIB 'Путь к каталогу с книгами'
		
1.7 Вручную запускаем разовое сканирование коллекции книг  
(Выполняется относительно долго: например, моя коллекция книг в архивах объемом 180Гб сканировалась в БД MYSQL - 1час)
1.7 Запускаем SCANNER сервер (опционально, необходим для автоматизированного периодического пересканирования коллекции) 
    Примите во внимание, что в  настройках по умолчанию задан периодический запуск сканирования 2 раза в день 12:00 и 0:00.

	python3 manage.py sopds_scanner scan --daemon
	python3 manage.py sopds_scanner start --daemon

1.8 Запускаем встроенный HTTP/OPDS сервер

@@ -50,15 +51,18 @@
Однако наилучшим способом, все же является настройка в качестве HTTP/OPDS серверов Apache или Nginx 
(точка входа ./sopds/wsgi.py)
	
1.9 Запускаем SCANNER сервер (опционально, необходим для автоматизированного периодического пересканирования коллекции)  
Перед запуском SCANNER сервера необходимо убедится, что сканирование, запущеное в п.1.6 уже завершено,
т.к. может возникнуть ситуация с запуском параллельного процесса сканирования, что может привести к ошибкам.
Примите во внимание, что в  настройках по умолчанию задан периодический запуск сканирования 2 раза 
в день 12:00 и 0:00.
1.9 Чтобы не дожидаться начала сканирования по расписанию, можно сообщить процессу sopds_scanner о необходимости
    немедленного сканирования. Сделать это можно, установив конфигурационный параметр SOPDS_SCAN_START_DIRECTLY = True 
    двумя способами:

	python3 manage.py sopds_scanner start --daemon
а) из консоли при помощи команды

	python3 manage.py sopds_util setconf SOPDS_SCAN_START_DIRECTLY True
	
б) При попомощи страницы администрирования Web-интерфейса http://<Ваш сервер>:8001/admin/ 
   (Далее CONSTANCE -> Настройки -> 1. General Options -> SOPDS_SCAN_START_DIRECTLY)
	
1.9 Доступ к информации  
1.10 Доступ к информации  
Если все предыдущие шаги выполнены успешно, то к библиотеке можно получить доступ по следующим URL:  

>     OPDS-версия: http://<Ваш сервер>:8001/opds/  
@@ -66,7 +70,7 @@

Следует принять во внимание, что по умолчанию в проекте используется простая БД sqlite3, которая
является одно-пользовательской. Поэтому пока не будет завершен процесс сканирования, запущенный 
ранее пунктом 1.6 попытки доступа к серверу будут завершаться ошибкой 
ранее попытки доступа к серверу могут завершаться ошибкой 
"A server error occurred.  Please contact the administrator."  
Для устранения указанной проблемы необходимо ипользовать многопользовательские БД, Например MYSQL.