WebSVN – oidplus – Diff – /trunk/userdata_pub/info.txt


 
About the folders "userdata" and "userdata_pub"
-----------------------------------------------
 
The folders "userdata" and "userdata_pub" contain various files that are unique
to your OIDplus installation. With a few exceptions (like the info.txt files),
the folder contents are safe from being accidentally changed or
deleted by SVN updates.
 
Generally speaking, everything inside these folders belongs to you,
and everything else belongs to OIDplus (and should not be changed!).
 
 
The folder "userdata"
---------------------
 
The folder "userdata" contains data from various plugins.
The access to this directory MUST be restricted,
because it can contain sensitive information like log files or
SQLite databases.
Therefore, please make sure that your webserver (e.g. Apache)
does not allow access to this directory.
If the access is not denied, please check .htaccess (for Apache),
nginx.conf (for Nginx) or web.config (for Microsoft IIS).
 
More information about the contents of the sub-folders
can be found in the info.txt file which is located in
each sub-folder.
 
 
The folder "userdata_pub"
-------------------------
 
The folder userdata_public/ can be used to store any kind of static
files that should be accessed through the web browser.
The access to this directory shall not be restricted.
 
Possible use cases:
- If you create an individual CSS file in userdata/style/oidplus_base.css
  (The CSS content will be processed by oidplus.min.css.php),
  and want to include individual graphics, then you can place the graphics in this directory.
- You can place documents in this directory, and link to them in OID descriptions
  (the "file attachments" or "documents and resources" plugins are recommended, though).

Subversion Repositories oidplus

oidplus/trunk/userdata_pub/info.txt – Rev 365 → 387

Rev 365		Rev 387
1		1
2	About the folders "userdata" and "userdata_pub"	2	About the folders "userdata" and "userdata_pub"
3	-----------------------------------------------	3	-----------------------------------------------
4		4
5	The folders "userdata" and "userdata_pub" contain various files that are unique	5	The folders "userdata" and "userdata_pub" contain various files that are unique
6	to your OIDplus installation. With a few exceptions (like the info.txt files),	6	to your OIDplus installation. With a few exceptions (like the info.txt files),
7	the folder contents are safe from being accidentally changed or	7	the folder contents are safe from being accidentally changed or
8	deleted by SVN updates.	8	deleted by SVN updates.
9		9
10	Generally speaking, everything inside these folders belongs to you,	10	Generally speaking, everything inside these folders belongs to you,
11	and everything else belongs to OIDplus (and should not be changed!).	11	and everything else belongs to OIDplus (and should not be changed!).
12		12
13		13
14	The folder "userdata"	14	The folder "userdata"
15	---------------------	15	---------------------
16		16
17	The folder "userdata" contains data from various plugins.	17	The folder "userdata" contains data from various plugins.
18	The access to this directory MUST be restricted,	18	The access to this directory MUST be restricted,
19	because it can contain sensitive information like log files or	19	because it can contain sensitive information like log files or
20	SQLite databases.	20	SQLite databases.
21	Therefore, please make sure that your webserver (e.g. Apache)	21	Therefore, please make sure that your webserver (e.g. Apache)
22	does not allow access to this directory.	22	does not allow access to this directory.
23	If the access is not denied, please check .htaccess (for Apache),	23	If the access is not denied, please check .htaccess (for Apache),
24	nginx.conf (for Nginx) or web.config (for Microsoft IIS).	24	nginx.conf (for Nginx) or web.config (for Microsoft IIS).
25		25
26	More information about the contents of the sub-folders	26	More information about the contents of the sub-folders
27	can be found in the info.txt file which is located in	27	can be found in the info.txt file which is located in
28	each sub-folder.	28	each sub-folder.
29		29
30		30
31	The folder "userdata_pub"	31	The folder "userdata_pub"
32	-------------------------	32	-------------------------
33		33
34	The folder userdata_public/ can be used to store any kind of static	34	The folder userdata_public/ can be used to store any kind of static
35	files that should be accessed through the web browser.	35	files that should be accessed through the web browser.
36	The access to this directory shall not be restricted.	36	The access to this directory shall not be restricted.
37		37
38	Possible use cases:	38	Possible use cases:
39	- If you create an individual CSS file in userdata/style/oidplus_base.css	39	- If you create an individual CSS file in userdata/style/oidplus_base.css
40	(The CSS content will be processed by oidplus.min.css.php),	40	(The CSS content will be processed by oidplus.min.css.php),
41	and want to include individual graphics, then you can place the graphics in this directory.	41	and want to include individual graphics, then you can place the graphics in this directory.
42	- You can place documents in this directory, and link to them in OID descriptions	42	- You can place documents in this directory, and link to them in OID descriptions
43	(the "file attachments" or "documents and resources" plugins are recommended, though).	43	(the "file attachments" or "documents and resources" plugins are recommended, though).