Procházet zdrojové kódy

fix README + Webdav default conf

Guénaël Muller před 6 roky
rodič
revize
ee147fe7c9
3 změnil soubory, kde provedl 59 přidání a 7 odebrání
  1. 1 0
      .gitignore
  2. 20 7
      README.md
  3. 38 0
      wsgidav.conf.sample

+ 1 - 0
.gitignore Zobrazit soubor

@@ -60,6 +60,7 @@ wsgidav.conf
60 60
 *~
61 61
 *.sqlite
62 62
 *.lock
63
+depot/
63 64
 
64 65
 # binary translation files
65 66
 *.mo

+ 20 - 7
README.md Zobrazit soubor

@@ -14,20 +14,23 @@ Installation
14 14
 
15 15
 ### Distribution dependencies ###
16 16
 
17
-on Debian Stretch (9) :
17
+on Debian Stretch (9) with sudo:
18 18
 
19
+    sudo apt update
19 20
     sudo apt install git
20
-    sudo apt install python3 python-virtualenv python3-dev python-pip
21
+    sudo apt install python3 python3-venv python3-dev python3-pip
21 22
 
22 23
 ### Get the source ###
23 24
 
25
+get source from github:
26
+
24 27
     git clone https://github.com/tracim/tracim_backend.git
25 28
 
26
-### Setup Python Virtualenv ###
29
+go to *tracim_backend* directory:
27 30
 
28
-Go to *tracim* subdirectory:
31
+    pushd tracim_backend
29 32
 
30
-    cd tracim
33
+### Setup Python Virtualenv ###
31 34
 
32 35
 Create a Python virtual environment:
33 36
 
@@ -64,7 +67,7 @@ For mySQL:
64 67
 
65 68
 Create [configuration file](doc/setting.md) for a development environment:
66 69
 
67
-    cp development.ini.base development.ini
70
+    cp development.ini.sample development.ini
68 71
 
69 72
 Initialize the database using [tracimcli](doc/cli.md) tool
70 73
 
@@ -76,6 +79,16 @@ Run your project:
76 79
 
77 80
     pserve development.ini
78 81
 
82
+### Configure and Run Webdav Server (Unstable) ###
83
+
84
+create wsgidav configuration file :
85
+
86
+    cp wsgidav.conf.sample wsgidav.conf
87
+
88
+run wsgidav server:
89
+
90
+    tracimcli webdav start
91
+
79 92
 ### Run Tests and others checks ###
80 93
 
81 94
 Run your project's tests:
@@ -88,7 +101,7 @@ Run mypy checks:
88 101
 
89 102
 Run pep8 checks:
90 103
 
91
-    pep8 tracim
104
+    pep8 tracim --exclude 'tracim/env'
92 105
 
93 106
 Tracim API
94 107
 ----------

+ 38 - 0
wsgidav.conf.sample Zobrazit soubor

@@ -0,0 +1,38 @@
1
+################################################################################
2
+# Sample WsgiDAV configuration file
3
+#
4
+# 1. Rename this file to `wsgidav.conf`
5
+# 2. Adjust settings as appropriate
6
+# 3. Run tracim as you always do :)
7
+#
8
+################################################################################
9
+
10
+################################################################################
11
+# SERVER OPTIONS
12
+#===============================================================================
13
+
14
+
15
+# host  = "localhost"
16
+# host  = "192.168.0.1"
17
+host  = "0.0.0.0"
18
+
19
+port = 3030
20
+
21
+show_history = True
22
+show_deleted = True
23
+show_archived = True
24
+
25
+manager_locks = True
26
+
27
+root_path = ''
28
+
29
+# Tracim doesn't support digest auth for webdav
30
+acceptbasic = True
31
+acceptdigest = False
32
+defaultdigest = False
33
+#===============================================================================
34
+# Lock Manager
35
+#
36
+# Example: Use PERSISTENT shelve based lock manager
37
+#from wsgidav.lock_storage import LockStorageShelve
38
+#locksmanager = LockStorageShelve("wsgidav-locks.shelve")