Skip to content
This repository
Browse code

Better docs.

  • Loading branch information...
commit b78365cd83a295c04525935cd6b40842e82f4ef1 1 parent 17b2f04
Philip Neustrom philipn authored
4 INSTALL
@@ -5,6 +5,8 @@ installation packages. Details here:
5 5
6 6 These packages are much easier to keep updated.
7 7
  8 +--------------------------------------------------------------------------------
  9 +
8 10 The following install instructions are geared for development setups or non-Ubuntu
9 11 installs.
10 12
@@ -53,7 +55,7 @@ Hooray! You can visit the site at http://127.0.0.1:8000/
53 55
54 56 Note: For security/efficiency, the built-in server listens on 127.0.0.1 only.
55 57 For real deployments you'll want to set up apache.
56   - See http://guide.localwiki.org for more instructions.
  58 + See https://dev.localwiki.org for more instructions.
57 59
58 60 Note: You'll want to run source env/bin/activate every time you want to access
59 61 the localwiki-manage command.
85 docs/html/_sources/configure.txt
... ... @@ -1,25 +1,47 @@
1 1 Web server configuration
2 2 ========================
3 3
4   -While you can run the LocalWiki software using the built-in development server,
5   -for a public-facing setup you're definitely better off using it with Apache and
6   -mod_wsgi.
7 4
8   -Here is a sample Apache configuration file::
  5 +Normal installation
  6 +--------------------
  7 +
  8 +If you installed the LocalWiki software using the Ubuntu package then an
  9 +Apache site should be automatically up and running. Its configuration file
  10 +can found in ``/etc/apache2/sites-enabled/example.com``. You'll want to
  11 +open that file and change the server name, etc.
  12 +
  13 +Please see the `official Apache documentation <http://httpd.apache.org/docs/>`_
  14 +for all possible configuration values.
  15 +
  16 +
  17 +Development server
  18 +------------------
  19 +
  20 +If you're doing development or testing, you can run ``localwiki-manage runserver``
  21 +to start the built-in webserver. Don't use this in production.
  22 +
  23 +
  24 +Manual installations
  25 +--------------------
  26 +
  27 +If you installed LocalWiki manually then you'll need to copy the
  28 +wsgi template file and edit it::
  29 +
  30 + mkdir deploy
  31 + cp install_config/localwiki_virtualenv.wsgi.template deploy/localwiki.wsgi
  32 +
  33 +Then open up ``localwiki.wsgi`` and set ``VIRTUAL_ENV_PATH`` to the absolute
  34 +path to the virtualenv you installed LocalWiki in.
  35 +
  36 +Then you'll need to create an Apache configuration file. Here's a
  37 +sample::
9 38
10 39 <VirtualHost *:80>
11 40 ServerAdmin webmaster@example.org
12 41 ServerName example.org
13 42 ServerAlias example.org www.example.org
14 43
15   - DocumentRoot /srv/sites/example/sapling
16   -
17   - <Directory /srv/sites/example/>
18   - Options -Indexes FollowSymLinks MultiViews
19   - AllowOverride None
20   - Order allow,deny
21   - allow from all
22   - </Directory>
  44 + CustomLog /var/log/apache2/access.log combined
23 45
24 46 # gzip content for much faster page loads.
25 47 <Location />
@@ -52,26 +74,35 @@ Here is a sample Apache configuration file::
52 74 SetEnv no-gzip
53 75 </Location>
54 76
55   - ErrorLog /var/log/apache2/error.log
56   -
57   - # Possible values include: debug, info, notice, warn, error, crit,
58   - # alert, emerg.
59   - LogLevel warn
60   -
61   - CustomLog /var/log/apache2/access.log combined
62   -
63   - WSGIScriptAlias / /srv/sites/example/sapling/deploy/django.wsgi
  77 + WSGIDaemonProcess localwiki threads=15 maximum-requests=10000
  78 + WSGIScriptAlias / /path/to/your/deploy/localwiki.wsgi
  79 + WSGIProcessGroup localwiki
64 80
65   - Alias /robots.txt /srv/sites/example/sapling/static/robots.txt
66   - Alias /favicon.ico /srv/sites/example/sapling/static/favicon.ico
67   - Alias /media/ /srv/sites/example/sapling/media/
68   - Alias /static/ /srv/sites/example/sapling/static/
  81 + Alias /robots.txt /path/to/your/env/share/localwiki/static/robots.txt
  82 + Alias /favicon.ico /path/to/your/env/share/localwiki/static/favicon.ico
  83 + Alias /media/ /path/to/your/env/share/localwiki/media/
  84 + Alias /static/ /path/to/your/env/share/localwiki/static/
69 85
70 86 # The media directory, which contains user-uploaded content,
71 87 # should be set to force downloads. This is *extremely* important
72 88 # for security reasons.
73 89 <Location /media/>
74   - Header set Content-Disposition attachment
  90 + Header set Content-Disposition attachment
75 91 </Location>
76 92
77   - </VirtualHost>
  93 +You'll need to set some of these values:
  94 +
  95 +``ServerAdmin``, ``ServerName``, and ``ServerAlias`` should be
  96 +self-explanatory. Read the Apache docs for more info.
  97 +
  98 +``WSGIScriptAlias / /path/to/your/deploy/localwiki.wsgi`` -- you'll need to
  99 +change ``/path/to/your/deploy/`` to be the path to where the ``localwiki.wsgi``
  100 +file lives.
  101 +
  102 +In all of the ``Alias ...`` lines you'll need to change
  103 +``/path/to/your/env`` to be the absolute path to the virtualenv where
  104 +you installed LocalWiki.
  105 +
  106 +After you make you're changes you'll need to restart Apache.
  107 +Please see the `official Apache documentation <http://httpd.apache.org/docs/>`_
  108 +for more on all this.
10 docs/html/_sources/install.txt
@@ -21,9 +21,17 @@ That's it! Follow the prompts to configure LocalWiki.
21 21 Installing on other systems
22 22 ---------------------------
23 23
24   -.. note:: This installation method is recommended only for developers.
  24 +.. note:: This installation method should only be used if you can't use
  25 + the Ubuntu package or if you want to set up a development
  26 + enviroment.
25 27
26 28 See our ``INSTALL`` file for detailed instructions. The file is also included
27 29 here:
28 30
29 31 .. literalinclude:: ../../INSTALL
  32 +
  33 +
  34 +More info
  35 +---------
  36 +
  37 +See https://dev.localwiki.org for more information on installation.
4 docs/html/_sources/permissions.txt
@@ -152,9 +152,9 @@ You can edit this setting by adding or removing permissions for certain groups
152 152 or adding your own groups. To apply these permissions (and overwrite the
153 153 previously set defaults), run the following command::
154 154
155   - python manage.py reset_permissions
  155 + localwiki-manage reset_permissions
156 156
157 157 .. note ::
158 158 Regardless of everything said in this section, administrators and superusers
159 159 are always granted all permissions, no matter what groups they are in or
160   - even whether they are in the ``Banned`` group.
  160 + even whether they are in the ``Banned`` group.
87 docs/html/configure.html
@@ -50,23 +50,37 @@
50 50
51 51 <div class="section" id="web-server-configuration">
52 52 <h1>Web server configuration<a class="headerlink" href="#web-server-configuration" title="Permalink to this headline">¶</a></h1>
53   -<p>While you can run the LocalWiki software using the built-in development server,
54   -for a public-facing setup you&#8217;re definitely better off using it with Apache and
55   -mod_wsgi.</p>
56   -<p>Here is a sample Apache configuration file:</p>
  53 +<div class="section" id="normal-installation">
  54 +<h2>Normal installation<a class="headerlink" href="#normal-installation" title="Permalink to this headline">¶</a></h2>
  55 +<p>If you installed the LocalWiki software using the Ubuntu package then an
  56 +Apache site should be automatically up and running. Its configuration file
  57 +can found in <tt class="docutils literal"><span class="pre">/etc/apache2/sites-enabled/example.com</span></tt>. You&#8217;ll want to
  58 +open that file and change the server name, etc.</p>
  59 +<p>Please see the <a class="reference external" href="http://httpd.apache.org/docs/">official Apache documentation</a>
  60 +for all possible configuration values.</p>
  61 +</div>
  62 +<div class="section" id="development-server">
  63 +<h2>Development server<a class="headerlink" href="#development-server" title="Permalink to this headline">¶</a></h2>
  64 +<p>If you&#8217;re doing development or testing, you can run <tt class="docutils literal"><span class="pre">localwiki-manage</span> <span class="pre">runserver</span></tt>
  65 +to start the built-in webserver. Don&#8217;t use this in production.</p>
  66 +</div>
  67 +<div class="section" id="manual-installations">
  68 +<h2>Manual installations<a class="headerlink" href="#manual-installations" title="Permalink to this headline">¶</a></h2>
  69 +<p>If you installed LocalWiki manually then you&#8217;ll need to copy the
  70 +wsgi template file and edit it:</p>
  71 +<div class="highlight-python"><pre>mkdir deploy
  72 +cp install_config/localwiki_virtualenv.wsgi.template deploy/localwiki.wsgi</pre>
  73 +</div>
  74 +<p>Then open up <tt class="docutils literal"><span class="pre">localwiki.wsgi</span></tt> and set <tt class="docutils literal"><span class="pre">VIRTUAL_ENV_PATH</span></tt> to the absolute
  75 +path to the virtualenv you installed LocalWiki in.</p>
  76 +<p>Then you&#8217;ll need to create an Apache configuration file. Here&#8217;s a
  77 +sample:</p>
57 78 <div class="highlight-python"><pre>&lt;VirtualHost *:80&gt;
58 79 ServerAdmin webmaster@example.org
59 80 ServerName example.org
60 81 ServerAlias example.org www.example.org
61 82
62   - DocumentRoot /srv/sites/example/sapling
63   -
64   - &lt;Directory /srv/sites/example/&gt;
65   - Options -Indexes FollowSymLinks MultiViews
66   - AllowOverride None
67   - Order allow,deny
68   - allow from all
69   - &lt;/Directory&gt;
  83 + CustomLog /var/log/apache2/access.log combined
70 84
71 85 # gzip content for much faster page loads.
72 86 &lt;Location /&gt;
@@ -99,29 +113,34 @@
99 113 SetEnv no-gzip
100 114 &lt;/Location&gt;
101 115
102   - ErrorLog /var/log/apache2/error.log
103   -
104   - # Possible values include: debug, info, notice, warn, error, crit,
105   - # alert, emerg.
106   - LogLevel warn
  116 + WSGIDaemonProcess localwiki threads=15 maximum-requests=10000
  117 + WSGIScriptAlias / /path/to/your/deploy/localwiki.wsgi
  118 + WSGIProcessGroup localwiki
107 119
108   - CustomLog /var/log/apache2/access.log combined
109   -
110   - WSGIScriptAlias / /srv/sites/example/sapling/deploy/django.wsgi
111   -
112   - Alias /robots.txt /srv/sites/example/sapling/static/robots.txt
113   - Alias /favicon.ico /srv/sites/example/sapling/static/favicon.ico
114   - Alias /media/ /srv/sites/example/sapling/media/
115   - Alias /static/ /srv/sites/example/sapling/static/
  120 + Alias /robots.txt /path/to/your/env/share/localwiki/static/robots.txt
  121 + Alias /favicon.ico /path/to/your/env/share/localwiki/static/favicon.ico
  122 + Alias /media/ /path/to/your/env/share/localwiki/media/
  123 + Alias /static/ /path/to/your/env/share/localwiki/static/
116 124
117 125 # The media directory, which contains user-uploaded content,
118 126 # should be set to force downloads. This is *extremely* important
119 127 # for security reasons.
120 128 &lt;Location /media/&gt;
121   - Header set Content-Disposition attachment
122   - &lt;/Location&gt;
123   -
124   -&lt;/VirtualHost&gt;</pre>
  129 + Header set Content-Disposition attachment
  130 + &lt;/Location&gt;</pre>
  131 +</div>
  132 +<p>You&#8217;ll need to set some of these values:</p>
  133 +<p><tt class="docutils literal"><span class="pre">ServerAdmin</span></tt>, <tt class="docutils literal"><span class="pre">ServerName</span></tt>, and <tt class="docutils literal"><span class="pre">ServerAlias</span></tt> should be
  134 +self-explanatory. Read the Apache docs for more info.</p>
  135 +<p><tt class="docutils literal"><span class="pre">WSGIScriptAlias</span> <span class="pre">/</span> <span class="pre">/path/to/your/deploy/localwiki.wsgi</span></tt> &#8211; you&#8217;ll need to
  136 +change <tt class="docutils literal"><span class="pre">/path/to/your/deploy/</span></tt> to be the path to where the <tt class="docutils literal"><span class="pre">localwiki.wsgi</span></tt>
  137 +file lives.</p>
  138 +<p>In all of the <tt class="docutils literal"><span class="pre">Alias</span> <span class="pre">...</span></tt> lines you&#8217;ll need to change
  139 +<tt class="docutils literal"><span class="pre">/path/to/your/env</span></tt> to be the absolute path to the virtualenv where
  140 +you installed LocalWiki.</p>
  141 +<p>After you make you&#8217;re changes you&#8217;ll need to restart Apache.
  142 +Please see the <a class="reference external" href="http://httpd.apache.org/docs/">official Apache documentation</a>
  143 +for more on all this.</p>
125 144 </div>
126 145 </div>
127 146
@@ -131,6 +150,16 @@
131 150 </div>
132 151 <div class="sphinxsidebar">
133 152 <div class="sphinxsidebarwrapper">
  153 + <h3><a href="index.html">Table Of Contents</a></h3>
  154 + <ul>
  155 +<li><a class="reference internal" href="#">Web server configuration</a><ul>
  156 +<li><a class="reference internal" href="#normal-installation">Normal installation</a></li>
  157 +<li><a class="reference internal" href="#development-server">Development server</a></li>
  158 +<li><a class="reference internal" href="#manual-installations">Manual installations</a></li>
  159 +</ul>
  160 +</li>
  161 +</ul>
  162 +
134 163 <h4>Previous topic</h4>
135 164 <p class="topless"><a href="install.html"
136 165 title="previous chapter">Installing</a></p>
13 docs/html/install.html
@@ -66,7 +66,9 @@
66 66 <h2>Installing on other systems<a class="headerlink" href="#installing-on-other-systems" title="Permalink to this headline">¶</a></h2>
67 67 <div class="admonition note">
68 68 <p class="first admonition-title">Note</p>
69   -<p class="last">This installation method is recommended only for developers.</p>
  69 +<p class="last">This installation method should only be used if you can&#8217;t use
  70 +the Ubuntu package or if you want to set up a development
  71 +enviroment.</p>
70 72 </div>
71 73 <p>See our <tt class="docutils literal"><span class="pre">INSTALL</span></tt> file for detailed instructions. The file is also included
72 74 here:</p>
@@ -77,6 +79,8 @@
77 79
78 80 These packages are much easier to keep updated.
79 81
  82 +--------------------------------------------------------------------------------
  83 +
80 84 The following install instructions are geared for development setups or non-Ubuntu
81 85 installs.
82 86
@@ -125,7 +129,7 @@
125 129
126 130 Note: For security/efficiency, the built-in server listens on 127.0.0.1 only.
127 131 For real deployments you'll want to set up apache.
128   - See http://guide.localwiki.org for more instructions.
  132 + See https://dev.localwiki.org for more instructions.
129 133
130 134 Note: You'll want to run source env/bin/activate every time you want to access
131 135 the localwiki-manage command.
@@ -157,6 +161,10 @@
157 161 </pre>
158 162 </div>
159 163 </div>
  164 +<div class="section" id="more-info">
  165 +<h2>More info<a class="headerlink" href="#more-info" title="Permalink to this headline">¶</a></h2>
  166 +<p>See <a class="reference external" href="https://dev.localwiki.org">https://dev.localwiki.org</a> for more information on installation.</p>
  167 +</div>
160 168 </div>
161 169
162 170
@@ -170,6 +178,7 @@
170 178 <li><a class="reference internal" href="#">Installing</a><ul>
171 179 <li><a class="reference internal" href="#installing-on-ubuntu">Installing on Ubuntu</a></li>
172 180 <li><a class="reference internal" href="#installing-on-other-systems">Installing on other systems</a></li>
  181 +<li><a class="reference internal" href="#more-info">More info</a></li>
173 182 </ul>
174 183 </li>
175 184 </ul>
2  docs/html/permissions.html
@@ -184,7 +184,7 @@
184 184 <p>You can edit this setting by adding or removing permissions for certain groups
185 185 or adding your own groups. To apply these permissions (and overwrite the
186 186 previously set defaults), run the following command:</p>
187   -<div class="highlight-python"><pre>python manage.py reset_permissions</pre>
  187 +<div class="highlight-python"><pre>localwiki-manage reset_permissions</pre>
188 188 </div>
189 189 <div class="admonition note">
190 190 <p class="first admonition-title">Note</p>
2  docs/html/searchindex.js
... ... @@ -1 +1 @@
1   -Search.setIndex({objects:{},terms:{all:[7,1,2,5,3],code:[],add_redirect:7,delete_pag:7,runserv:5,follow:[2,5,7],bmsi:2,depend:5,multiview:2,under:3,localset:3,setoutputfilt:2,sourc:[4,5],everi:[5,7],createsuperus:3,hoorai:5,administr:[7,3],level:7,webmast:2,list:3,upload:2,adjust:7,delete_mapdata:7,embed_allowed_url:3,pleas:[4,5],malici:7,pass:3,download:2,click:[7,3],append:2,sapl:2,index:[0,2],what:[7,5,3],navig:3,followsymlink:2,section:7,abl:[5,7],access:[2,5],delet:[5,7],version:1,"new":[1,5,7],method:5,widget:3,gener:5,here:[1,2,5,3],let:[4,7],serveradmin:2,ubuntu:[1,5],modifi:[7,3],valu:2,box:7,search:[0,5,7],errorlog:2,action:3,extrem:2,chang:[7,3],regardless:7,prerequisit:5,activ:5,modul:0,apt:[1,5],ask:5,unix:5,api:3,instal:[0,7,1,5,3],txt:2,select:7,highli:5,regex:2,from:[7,2,3],visit:5,two:7,next:7,few:7,call:7,usr:3,recommend:5,type:[7,3],more:[7,4,2,5,3],desir:2,peopl:7,mozilla:2,notic:2,site:[2,5,3],warn:2,indic:0,particular:[5,3],hold:7,easiest:5,topic:[0,6,5],none:2,alia:2,setup:[2,5],work:2,delete_pagefil:7,dev:[1,4,6,5],can:[7,4,2,5,3],control:[7,3],pagefil:7,prompt:[5,3],give:7,lock:7,sudo:[1,5],share:[5,3],templat:3,customlog:2,want:[7,4,5,3],masquerad:2,alwai:7,lxml:5,secur:[2,5],write:7,how:5,env:[2,5],instead:7,simpl:[1,5],updat:[1,5],map:[7,3],add_mapdata:7,spot:5,superus:[7,3],wrong:2,mai:[5,3],data:[1,5],github:5,practic:7,loglevel:2,bind:5,robot:2,django:[2,5],maintain:7,environ:5,allow:[2,5,7],enter:[7,3],order:[2,5],olwidget_default_opt:3,help:5,becaus:7,jpeg:2,veri:[1,5],through:7,still:7,vari:2,group:7,psycopg2:5,better:[4,2],main:4,easier:[5,7],them:7,good:7,mapdata:7,thei:7,python:[5,7],initi:5,front:7,now:[5,7],request_uri:2,name:[7,3],edit:[5,7],config:5,authent:7,each:7,debug:2,found:[4,3],button:7,upgrading_localwiki:1,domain:3,serveralia:2,individu:7,site_them:3,realli:5,"static":[2,3],our:5,special:5,out:7,shown:[7,3],content:[0,2,3],default_lat:3,ref:5,correct:5,msie:2,postgr:5,proxi:2,insid:5,advanc:[0,6],given:7,standard:5,reason:2,base:[7,3],theori:5,postgi:5,org:[6,1,4,2,5],alert:2,gdal:5,mac:7,keep:5,filter:2,thing:[5,3],add_pag:7,gif:2,first:[5,7],softwar:[2,5],dont:2,directli:7,restrict:3,instruct:[1,5,7],alreadi:2,done:[5,3],crit:2,open:[4,5,7],differ:[5,7],mod_setenvif:2,workaround:2,script:5,top:7,system:[7,5,3],attach:2,termin:5,jetti:5,store:5,listen:5,gear:5,default_lon:3,"public":2,setuptool:5,"short":5,png:2,users_default_group:7,add_pagefil:7,kind:3,prebuilt:5,provid:7,remov:7,project:4,matter:7,sai:7,ani:[7,4,5,3],favicon:2,packag:[1,5],have:[7,2,3],deliv:2,need:[7,4,5,3],option:2,wsgiscriptalia:2,built:[2,5],note:[2,5,7],also:[5,7],exampl:[2,7],take:5,which:[2,7],combin:2,tool:3,channel:4,even:[4,7],sure:[2,5],deploy:5,usernam:7,who:7,reach:4,said:7,deploi:2,geodjango:5,don:[2,5,3],setenvifnocas:2,url:3,doc:5,clear:7,face:2,deni:[2,7],install_config:5,awesom:4,wsgi:2,text:2,permiss:[0,7],fine:2,find:7,redirect:7,onli:[2,5,7],users_default_permiss:7,locat:[2,3],pretti:7,configur:[0,2,5],apach:[2,5],should:[1,2,5,7],theme:3,localwiki:[0,1,2,3,4,5,6,7],cloudmade_api_kei:3,contribut:[0,4],get:[1,2,5],express:3,pypi:5,soon:3,ssl:6,fastest:4,emb:3,patch:4,whether:7,stuff:5,contain:[2,7],ban:7,getlatlon:3,view:7,wiki:5,set:[0,7,2,5,3],change_redirect:7,see:[4,6,5,3],flexibl:7,change_mapdata:7,databas:5,someth:5,won:2,between:5,"import":[2,5],irc:4,kei:3,screen:7,solr:5,embed:3,addit:7,protect:7,admin:[7,3],reset_permiss:7,etc:[7,2,3],agent:2,login:3,com:[5,3],load:2,simpli:[7,3],color:3,change_pag:7,header:2,diff:5,guid:5,assum:[2,5],backend:7,come:[7,3],due:2,much:[2,5,7],imag:[2,5],"catch":7,those:7,setup_al:5,look:[7,5,3],servic:5,properti:5,"while":[2,7],abov:2,error:2,anonym:7,everyon:7,anonymousus:7,real:5,tabl:0,jpe:2,non:5,conf:3,users_anonymous_group:7,develop:[4,2,5,3],grant:7,media:2,make:[4,2,5,7],belong:7,read:1,html:2,document:[0,5],mod_wsgi:2,complet:5,geograph:5,http:[1,4,6,5,3],effect:2,companion:5,auth:7,recent:3,setup_jetti:5,off:2,inherit:7,without:5,command:[1,5,7],thi:[7,1,2,5,3],choos:7,gzip:2,everyth:[4,7],left:3,just:5,documentroot:2,previous:7,web:[0,2,3],easi:7,except:7,apache2:2,add:[5,7],other:[5,7],appli:7,save:[7,3],bin:5,applic:7,preserv:1,disposit:2,know:4,press:[7,3],password:3,insert:2,like:[5,7],specif:[5,7],hunt:5,manual:1,server:[0,2,5],delete_redirect:7,either:7,page:[0,2,7],www:[2,3],right:[7,3],some:[2,5,3],back:[5,7],sampl:2,librari:5,virtualenv:5,trust:7,ico:2,djangoproject:5,definit:2,per:7,proj:5,localhost:3,machin:3,peek:5,object:[7,3],run:[7,1,2,5,3],compress:2,step:5,repositori:5,deflat:2,postgresql:5,manag:[7,5,3],regular:3,srv:2,ppa:5,own:7,effici:5,change_pagefil:7,easy_instal:5,automat:7,upgrad:[0,1,5],down:[5,7],cloudmad:3,netscap:2,contrib:5,your:[7,1,4,5,3],log:[2,7],wai:[4,5],support:5,overwrit:7,custom:5,avail:5,start:5,interfac:[7,3],includ:[1,2,5,3],lot:7,"var":2,forc:2,newer:5,bug:[4,2],info:[2,5],possibl:[2,5,7],"default":[7,3],wish:3,displai:3,browsermatch:2,hand:7,problem:2,creat:[7,5,3],certain:7,dure:1,exist:5,file:[7,2,5,3],doe:3,setting_up_ssl:6,user:[7,2,3],when:[7,1,3],detail:[5,3],setenv:2,role:7,test:5,you:[1,2,3,4,5,7],servernam:2,allowoverrid:2,releas:1,bmsie:2,faster:2,directori:[2,5,3],virtualhost:2,emerg:2,time:[5,7],scroll:7},objtypes:{},titles:["LocalWiki Documentation","Upgrading","Web server configuration","Settings","Contributing","Installing","Advanced topics","Permissions"],objnames:{},filenames:["index","upgrade","configure","settings","contribute","install","advanced","permissions"]})
  1 +Search.setIndex({objects:{},terms:{all:[7,1,2,5,3],code:[],add_redirect:7,delete_pag:7,runserv:[2,5],follow:[2,5,7],bmsi:2,depend:5,multiview:[],under:3,localset:3,setoutputfilt:2,sourc:[4,5],everi:[5,7],createsuperus:3,hoorai:5,administr:[7,3],level:7,webmast:2,list:3,upload:2,adjust:7,delete_mapdata:7,embed_allowed_url:3,pleas:[4,2,5],malici:7,pass:3,download:2,click:[7,3],append:2,sapl:[],index:0,what:[7,5,3],navig:3,followsymlink:[],section:7,abl:[5,7],access:[2,5],delet:[5,7],version:1,"new":[1,5,7],method:5,widget:3,gener:5,here:[1,2,5,3],let:[4,7],serveradmin:2,ubuntu:[1,2,5],path:2,modifi:[7,3],valu:2,box:7,search:[0,5,7],errorlog:[],action:3,extrem:2,chang:[7,2,3],regardless:7,prerequisit:5,apach:[2,5],modul:0,apt:[1,5],ask:5,unix:5,api:3,instal:[0,1,2,3,5,7],txt:2,select:7,highli:5,regex:2,httpd:[],from:[7,3],visit:5,two:7,next:7,few:7,live:2,call:7,usr:3,localwiki_virtualenv:2,recommend:5,type:[7,3],more:[7,4,2,5,3],desir:2,peopl:7,mozilla:2,notic:[],site:[2,5,3],warn:[],indic:0,particular:[5,3],hold:7,easiest:5,topic:[0,6,5],none:[],alia:2,setup:5,work:2,delete_pagefil:7,dev:[1,4,6,5],can:[7,4,2,5,3],control:[7,3],pagefil:7,prompt:[5,3],give:7,lock:7,sudo:[1,5],share:[2,5,3],templat:[2,3],customlog:2,want:[7,4,2,5,3],masquerad:2,alwai:7,lxml:5,secur:[2,5],write:7,how:5,env:[2,5],instead:7,simpl:[1,5],updat:[1,5],map:[7,3],product:2,add_mapdata:7,after:2,spot:5,superus:[7,3],wrong:2,mai:[5,3],data:[1,5],"short":5,practic:7,loglevel:[],bind:5,robot:2,django:5,inform:5,maintain:7,environ:5,allow:[5,7],enter:[7,3],order:5,olwidget_default_opt:3,help:5,offici:2,becaus:7,jpeg:2,veri:[1,5],through:7,still:7,vari:2,group:7,psycopg2:5,better:4,main:4,easier:[5,7],them:7,good:7,mapdata:7,thei:7,python:5,initi:5,front:7,now:[5,7],request_uri:2,name:[7,2,3],edit:[2,5,7],config:5,authent:7,each:7,debug:[],found:[4,2,3],button:7,upgrading_localwiki:1,domain:3,serveralia:2,individu:7,site_them:3,realli:5,"static":[2,3],our:5,special:5,out:7,shown:[7,3],content:[0,2,3],default_lat:3,ref:5,correct:5,msie:2,postgr:5,proxi:2,insid:5,advanc:[0,6],given:7,standard:5,reason:2,base:[7,3],theori:5,postgi:5,org:[6,1,4,2,5],alert:[],gdal:5,thread:2,mac:7,keep:5,filter:2,thing:[5,3],add_pag:7,gif:2,first:[5,7],softwar:[2,5],dont:2,directli:7,restrict:3,instruct:[1,5,7],alreadi:2,done:[5,3],crit:[],open:[4,2,5,7],differ:[5,7],mod_setenvif:2,workaround:2,script:5,top:7,mkdir:2,system:[7,5,3],attach:2,termin:5,jetti:5,store:5,listen:5,gear:5,default_lon:3,"public":[],copi:2,setuptool:5,part:[],png:2,users_default_group:7,add_pagefil:7,kind:3,prebuilt:5,provid:7,remov:7,project:4,matter:7,sai:7,ani:[7,4,5,3],favicon:2,packag:[1,2,5],have:[7,2,3],deliv:2,need:[7,4,2,5,3],option:[],wsgiscriptalia:2,built:[2,5],self:2,note:[2,5,7],also:[5,7],exampl:[2,7],take:5,which:[2,7],combin:2,tool:3,channel:4,even:[4,7],sure:[2,5],deploy:5,usernam:7,who:7,reach:4,said:7,deploi:2,geodjango:5,don:[2,5,3],setenvifnocas:2,url:3,doc:[2,5],clear:7,request:2,face:[],deni:7,install_config:[2,5],awesom:4,wsgi:2,text:2,permiss:[0,7],fine:2,find:7,redirect:7,absolut:2,onli:[2,5,7],users_default_permiss:7,locat:[2,3],pretti:7,configur:[0,2,5],activ:5,should:[1,2,5,7],theme:3,localwiki:[0,1,2,3,4,5,6,7],wsgidaemonprocess:2,cloudmade_api_kei:3,contribut:[0,4],get:[1,2,5],express:3,pypi:5,soon:3,ssl:6,fastest:4,restart:2,enabl:2,emb:3,patch:4,whether:7,stuff:5,contain:[2,7],ban:7,getlatlon:3,where:2,view:7,wiki:5,set:[0,7,2,5,3],change_redirect:7,displai:3,see:[4,6,2,5,3],flexibl:7,change_mapdata:7,databas:5,someth:5,won:2,between:5,"import":[2,5],irc:4,kei:3,screen:7,solr:5,embed:3,addit:7,protect:7,admin:[7,3],reset_permiss:7,etc:[7,2,3],agent:2,login:3,com:[2,5,3],load:2,simpli:[7,3],point:[],color:3,change_pag:7,header:2,diff:5,guid:5,assum:[2,5],backend:7,come:[7,3],due:2,github:5,wsgiprocessgroup:2,much:[2,5,7],imag:[2,5],"catch":7,those:7,setup_al:5,look:[7,5,3],servic:5,properti:5,"while":7,abov:2,error:[],anonym:7,everyon:7,anonymousus:7,real:5,tabl:0,jpe:2,non:5,conf:3,users_anonymous_group:7,develop:[4,2,5,3],grant:7,media:2,make:[4,2,5,7],belong:7,read:[1,2],html:2,document:[0,2,5],mod_wsgi:[],complet:5,geograph:5,http:[1,4,6,5,3],webserv:2,effect:2,companion:5,auth:7,recent:3,setup_jetti:5,off:[],inherit:7,without:5,command:[1,5,7],thi:[7,1,2,5,3],choos:7,gzip:2,everyth:[4,7],left:3,just:5,documentroot:[],previous:7,web:[0,2,3],easi:7,except:7,apache2:2,add:[5,7],other:[5,7],appli:7,virtual_env_path:2,save:[7,3],explanatori:2,bin:5,applic:7,preserv:1,disposit:2,know:4,press:[7,3],password:3,insert:2,like:[5,7],specif:[5,7],hunt:5,manual:[1,2],server:[0,2,5],delete_redirect:7,either:7,page:[0,2,7],www:[2,3],right:[7,3],some:[2,5,3],back:[5,7],sampl:2,enviro:5,librari:5,virtualenv:[2,5],trust:7,ico:2,djangoproject:5,normal:2,definit:[],per:7,proj:5,localhost:3,machin:3,peek:5,object:[7,3],run:[7,1,2,5,3],compress:2,step:5,repositori:5,deflat:2,postgresql:5,manag:[7,2,5,3],regular:3,srv:[],ppa:5,own:7,effici:5,change_pagefil:7,easy_instal:5,automat:[2,7],upgrad:[0,1,5],down:[5,7],cloudmad:3,netscap:2,contrib:5,your:[1,2,3,4,5,7],log:[2,7],wai:[4,5],support:5,overwrit:7,custom:5,avail:5,start:[2,5],interfac:[7,3],includ:[1,5,3],lot:7,"var":2,forc:2,newer:5,line:2,bug:[4,2],info:[2,5],possibl:[2,5,7],"default":[7,3],wish:3,maximum:2,browsermatch:2,hand:7,problem:2,creat:[7,2,5,3],certain:7,dure:1,exist:5,file:[7,2,5,3],doe:3,setting_up_ssl:6,user:[7,2,3],when:[7,1,3],detail:[5,3],setenv:2,role:7,test:[2,5],you:[1,2,3,4,5,7],servernam:2,allowoverrid:[],releas:1,bmsie:2,faster:2,directori:[2,5,3],virtualhost:2,emerg:[],time:[5,7],scroll:7},objtypes:{},titles:["LocalWiki Documentation","Upgrading","Web server configuration","Settings","Contributing","Installing","Advanced topics","Permissions"],objnames:{},filenames:["index","upgrade","configure","settings","contribute","install","advanced","permissions"]})
85 docs/source/configure.rst
Source Rendered
... ... @@ -1,25 +1,47 @@
1 1 Web server configuration
2 2 ========================
3 3
4   -While you can run the LocalWiki software using the built-in development server,
5   -for a public-facing setup you're definitely better off using it with Apache and
6   -mod_wsgi.
7 4
8   -Here is a sample Apache configuration file::
  5 +Normal installation
  6 +--------------------
  7 +
  8 +If you installed the LocalWiki software using the Ubuntu package then an
  9 +Apache site should be automatically up and running. Its configuration file
  10 +can found in ``/etc/apache2/sites-enabled/example.com``. You'll want to
  11 +open that file and change the server name, etc.
  12 +
  13 +Please see the `official Apache documentation <http://httpd.apache.org/docs/>`_
  14 +for all possible configuration values.
  15 +
  16 +
  17 +Development server
  18 +------------------
  19 +
  20 +If you're doing development or testing, you can run ``localwiki-manage runserver``
  21 +to start the built-in webserver. Don't use this in production.
  22 +
  23 +
  24 +Manual installations
  25 +--------------------
  26 +
  27 +If you installed LocalWiki manually then you'll need to copy the
  28 +wsgi template file and edit it::
  29 +
  30 + mkdir deploy
  31 + cp install_config/localwiki_virtualenv.wsgi.template deploy/localwiki.wsgi
  32 +
  33 +Then open up ``localwiki.wsgi`` and set ``VIRTUAL_ENV_PATH`` to the absolute
  34 +path to the virtualenv you installed LocalWiki in.
  35 +
  36 +Then you'll need to create an Apache configuration file. Here's a
  37 +sample::
9 38
10 39 <VirtualHost *:80>
11 40 ServerAdmin webmaster@example.org
12 41 ServerName example.org
13 42 ServerAlias example.org www.example.org
14 43
15   - DocumentRoot /srv/sites/example/sapling
16   -
17   - <Directory /srv/sites/example/>
18   - Options -Indexes FollowSymLinks MultiViews
19   - AllowOverride None
20   - Order allow,deny
21   - allow from all
22   - </Directory>
  44 + CustomLog /var/log/apache2/access.log combined
23 45
24 46 # gzip content for much faster page loads.
25 47 <Location />
@@ -52,26 +74,35 @@ Here is a sample Apache configuration file::
52 74 SetEnv no-gzip
53 75 </Location>
54 76
55   - ErrorLog /var/log/apache2/error.log
56   -
57   - # Possible values include: debug, info, notice, warn, error, crit,
58   - # alert, emerg.
59   - LogLevel warn
60   -
61   - CustomLog /var/log/apache2/access.log combined
62   -
63   - WSGIScriptAlias / /srv/sites/example/sapling/deploy/django.wsgi
  77 + WSGIDaemonProcess localwiki threads=15 maximum-requests=10000
  78 + WSGIScriptAlias / /path/to/your/deploy/localwiki.wsgi
  79 + WSGIProcessGroup localwiki
64 80
65   - Alias /robots.txt /srv/sites/example/sapling/static/robots.txt
66   - Alias /favicon.ico /srv/sites/example/sapling/static/favicon.ico
67   - Alias /media/ /srv/sites/example/sapling/media/
68   - Alias /static/ /srv/sites/example/sapling/static/
  81 + Alias /robots.txt /path/to/your/env/share/localwiki/static/robots.txt
  82 + Alias /favicon.ico /path/to/your/env/share/localwiki/static/favicon.ico
  83 + Alias /media/ /path/to/your/env/share/localwiki/media/
  84 + Alias /static/ /path/to/your/env/share/localwiki/static/
69 85
70 86 # The media directory, which contains user-uploaded content,
71 87 # should be set to force downloads. This is *extremely* important
72 88 # for security reasons.
73 89 <Location /media/>
74   - Header set Content-Disposition attachment
  90 + Header set Content-Disposition attachment
75 91 </Location>
76 92
77   - </VirtualHost>
  93 +You'll need to set some of these values:
  94 +
  95 +``ServerAdmin``, ``ServerName``, and ``ServerAlias`` should be
  96 +self-explanatory. Read the Apache docs for more info.
  97 +
  98 +``WSGIScriptAlias / /path/to/your/deploy/localwiki.wsgi`` -- you'll need to
  99 +change ``/path/to/your/deploy/`` to be the path to where the ``localwiki.wsgi``
  100 +file lives.
  101 +
  102 +In all of the ``Alias ...`` lines you'll need to change
  103 +``/path/to/your/env`` to be the absolute path to the virtualenv where
  104 +you installed LocalWiki.
  105 +
  106 +After you make you're changes you'll need to restart Apache.
  107 +Please see the `official Apache documentation <http://httpd.apache.org/docs/>`_
  108 +for more on all this.
10 docs/source/install.rst
Source Rendered
@@ -21,9 +21,17 @@ That's it! Follow the prompts to configure LocalWiki.
21 21 Installing on other systems
22 22 ---------------------------
23 23
24   -.. note:: This installation method is recommended only for developers.
  24 +.. note:: This installation method should only be used if you can't use
  25 + the Ubuntu package or if you want to set up a development
  26 + enviroment.
25 27
26 28 See our ``INSTALL`` file for detailed instructions. The file is also included
27 29 here:
28 30
29 31 .. literalinclude:: ../../INSTALL
  32 +
  33 +
  34 +More info
  35 +---------
  36 +
  37 +See https://dev.localwiki.org for more information on installation.
4 docs/source/permissions.rst
Source Rendered
@@ -152,9 +152,9 @@ You can edit this setting by adding or removing permissions for certain groups
152 152 or adding your own groups. To apply these permissions (and overwrite the
153 153 previously set defaults), run the following command::
154 154
155   - python manage.py reset_permissions
  155 + localwiki-manage reset_permissions
156 156
157 157 .. note ::
158 158 Regardless of everything said in this section, administrators and superusers
159 159 are always granted all permissions, no matter what groups they are in or
160   - even whether they are in the ``Banned`` group.
  160 + even whether they are in the ``Banned`` group.

0 comments on commit b78365c

Please sign in to comment.
Something went wrong with that request. Please try again.