Rev 364 | Go to most recent revision | Show entire file | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 364 | Rev 365 | ||
---|---|---|---|
Line 1... | Line 1... | ||
1 | 1 | ||
- | 2 | About the folders "userdata" and "userdata_pub" |
|
- | 3 | ----------------------------------------------- |
|
- | 4 | ||
2 | The folder "userdata" contains various files that are unique |
5 | The folders "userdata" and "userdata_pub" contain various files that are unique |
3 | to your OIDplus installation. With a few exceptions (like this file), |
6 | to your OIDplus installation. With a few exceptions (like the info.txt files), |
4 | the folder contents are safe from being accidentally changed or |
7 | the folder contents are safe from being accidentally changed or |
5 | deleted by SVN updates. |
8 | deleted by SVN updates. |
6 | 9 | ||
7 | Generally speaking, everything inside "userdata" belongs to you, |
10 | Generally speaking, everything inside these folders belongs to you, |
8 | and everything else belongs to OIDplus (and should not be changed). |
11 | and everything else belongs to OIDplus (and should not be changed!). |
9 | - | ||
10 | Since this folder can also contain sensitive information |
- | |
11 | like log files or a SQLite database, the access to this |
- | |
12 | directory must be restricted. Therefore, please make sure |
- | |
13 | that your webserver (e.g. Apache) does not allow access |
- | |
14 | to this directory. |
- | |
15 | If the access is not denied, please check .htaccess (for Apache), |
- | |
16 | nginx.conf (for Nginx) or web.config (for Microsoft IIS). |
- | |
17 | 12 | ||
18 | Various plugins can put their data in this directory. |
- | |
19 | Here is a list of typical sub-folders: |
- | |
20 | 13 | ||
- | 14 | The folder "userdata" |
|
- | 15 | --------------------- |
|
21 | 16 | ||
- | 17 | The folder "userdata" contains data from various plugins. |
|
- | 18 | The access to this directory MUST be restricted, |
|
- | 19 | because it can contain sensitive information like log files or |
|
22 | Folder "attachments" |
20 | SQLite databases. |
- | 21 | Therefore, please make sure that your webserver (e.g. Apache) |
|
23 | -------------------- |
22 | does not allow access to this directory. |
24 | - | ||
25 | Used by the plugin "publicPages/095_attachments". |
23 | If the access is not denied, please check .htaccess (for Apache), |
- | 24 | nginx.conf (for Nginx) or web.config (for Microsoft IIS). |
|
26 | 25 | ||
27 | Contents: |
- | |
28 | - userdata/attachments/filetypes.conf (optional) to define/overwrite fileformat descriptions placed in 3p/vts_fileformats/filetypes.conf |
- | |
29 | - Folders with attachments users have uploaded. |
26 | More information about the contents of the sub-folders |
30 | - | ||
31 | Example for folder names: |
- | |
32 | oid_2_999: for a normal OID |
- | |
33 | oid_1_3_6_1_4_1_37476_30_9_<sysid>_<smallhash>: for a non-OID object |
- | |
34 | If your system does not have a public key / system ID (e.g. because of missing OpenSSL), the names are |
- | |
35 | oid_2_999: for a normal OID |
- | |
36 | oid_2_25_<...>: for a GUID |
- | |
37 | <md5hash>: for other non-OID objects |
- | |
38 | - | ||
39 | In order for the file attachment upload to work, |
27 | can be found in the info.txt file which is located in |
40 | you need to adjust the folder permissions. |
- | |
41 | For example, on Linux "chown" to the user "www-data" or "chmod" to "0777". |
- | |
42 | - | ||
43 | - | ||
44 | Folder "baseconfig" |
28 | each sub-folder. |
45 | ------------------- |
- | |
46 | - | ||
47 | The folder "baseconfig" contains the file "config.inc.php" which defines |
- | |
48 | important static settings like the database connection credentials or |
- | |
49 | security keys (ReCaptcha) etc. |
- | |
50 | Setup (/setup/) will show assist you in creating this config.inc.php file. |
- | |
51 | 29 | ||
52 | 30 | ||
53 | Folder "database" |
31 | The folder "userdata_pub" |
54 | ----------------- |
32 | ------------------------- |
55 | 33 | ||
56 | This folder can be used to store a SQLite database. |
34 | The folder userdata_public/ can be used to store any kind of static |
57 | The default database name is" oidplus.db" |
- | |
58 | - | ||
59 | - | ||
60 | Folder "favicon" |
- | |
61 | ---------------- |
- | |
62 | - | ||
63 | If the file favicon.ico is existing, it will be chosen instead of img/favicon.ico |
- | |
64 | - | ||
65 | - | ||
66 | Folder "logs" |
- | |
67 | ------------- |
- | |
68 | - | ||
69 | Contains the file oidplus.log created by plugin "logger/300_userdata_logfile". |
- | |
70 | Having log messages stored in the log files makes |
- | |
71 | processing of data easier. For example you can use "fail2ban" to |
- | |
72 | analyze the log file and automatically ban IP addresses of networks |
- | |
73 | that try to brute force an user account password. |
- | |
74 | - | ||
75 | Note: |
- | |
76 | - Make sure that oidplus.log can be written by your webserver (e.g. Apache). |
- | |
77 | - You can shrink the size of oidplus.log by using logrotate (only Linux) |
- | |
78 | - | ||
79 | - | ||
80 | Folder "resources" |
- | |
81 | ------------------ |
- | |
82 | - | ||
83 | This folder is used by the plugin "publicPages/500_resources" |
- | |
84 | (Section "Documents and resources") |
- | |
85 | - | ||
86 | Its contents will be merged with "res/" from the root directory. |
35 | files that should be accessed through the web browser. |
87 | "res/" contains the default resources which are part of the OIDplus |
- | |
88 | main installation (you shall not change or add anything to that folder), |
- | |
89 | while "userdata/resources" contains resources that you add yourself |
- | |
90 | (e.g. your impress, privacy statement, additional resources, |
- | |
91 | hyperlinks to your websites and products, etc.) |
- | |
92 | - | ||
93 | Valid contents: |
- | |
94 | - Subfolders |
- | |
95 | - *.html files |
- | |
96 | - *.link files (will be converted to a hyperlink in the menu on the left) |
- | |
97 | - *.url files (will be converted to a hyperlink in the menu on the left. |
- | |
98 | No internationalization possible, therefore deprecated!) |
- | |
99 | - | ||
100 | Icons: |
- | |
101 | You can define custom icons for any any file or folder by placing PNG files |
- | |
102 | with the following file names: |
- | |
103 | - | ||
104 | Assume the ressource file <filename>.html , then the icon files are: |
- | |
105 | <filename>_big.png (Big icon in the content-pane) |
- | |
106 | <filename>_big$dede.png (German-specific icon) |
- | |
107 | <filename>_tree.png (Icon in the tree view, 16x16) |
- | |
108 | <filename>_tree$dede.png (German-specific tree icon) |
- | |
109 | - | ||
110 | The same applies for folders. |
- | |
111 | - | ||
112 | Internationalization of *.html files: |
- | |
113 | Title: The title is taken from the HTML headline. |
36 | The access to this directory shall not be restricted. |
114 | To create a file with multiple languages, create them like this: |
- | |
115 | example.html <-- this is the file in the default language ("enus" = English USA) |
- | |
116 | example$dede.html <-- this is the file for German ("dede") |
- | |
117 | Attention: The main file (without language code) needs to exist, so this is NOT possible: |
- | |
118 | example$enus.html <-- DO NOT USE |
- | |
119 | example$dede.html |
- | |
120 | 37 | ||
121 | Internationalization of *.link files: |
- | |
122 | Title: |
- | |
123 | .link files are like .url files, but they have an attribute for defining a title. |
- | |
124 | The file format is like this: |
- | |
125 | [Link] |
- | |
126 | Title="Report a bug" |
38 | Possible use cases: |
127 | URL="https://www.viathinksoft.com/thinkbug/thinkbug.php?id=97" |
- | |
128 | To create an URL with multiple languages, create them like this: |
39 | - If you create an individual CSS file in userdata/style/oidplus_base.css |
129 | example.link <-- this is the file in the default language ("enus" = English USA) |
- | |
130 | example$dede.link <-- this is the file for German ("dede") |
- | |
131 | Attention: The main file (without language code) needs to exist, so this is NOT possible: |
- | |
132 | example$enus.link <-- DO NOT USE |
- | |
133 | example$dede.link |
- | |
134 | - | ||
135 | Internationalization of *.url files: |
- | |
136 | .url files are the normal files that can be created using Microsoft Windows. |
- | |
137 | Internationalization of *.url files is not possible. |
- | |
138 | Title: |
- | |
139 | The title is taken from the file name. |
- | |
140 | You need to create two entries which are always both visible in the menu, |
40 | (The CSS content will be processed by oidplus.min.css.php), |
141 | independent from the chosen language: |
- | |
142 | - "Report a bug.url" |
- | |
143 | - "Einen Fehler melden.url" |
- | |
144 | - | ||
145 | Internationalization of Folder names: |
- | |
146 | By default, the folder title is the name of the directory. |
- | |
147 | To change it, you can place a folder.ini with the following contents: |
- | |
148 | [Folder] |
- | |
149 | Title="Object Identifiers" |
- | |
150 | For multilinguality, e.g. create folder$dede.ini for a German name |
- | |
151 | [Folder] |
- | |
152 | Title="Objekt-Bezeichner (OID)" |
- | |
153 | Please note that the URL is always the same and exposes the real directory name: |
41 | and want to include individual graphics, then you can place the graphics in this directory. |
154 | ...?goto=oidplus:resources$Object Identifiers/ |
- | |
155 | - | ||
156 | - | ||
157 | Folder "styles" |
- | |
158 | --------------- |
- | |
159 | - | ||
160 | In this folder, you can place an alternative version of oidplus_base.css and setup_base.css. |
- | |
161 | - | ||
162 | ATTENTION: |
- | |
163 | - You need to make sure that your changes are in-sync with the current versions |
42 | - You can place documents in this directory, and link to them in OID descriptions |
164 | of oidplus_base.css and setup_base.css! |
- | |
165 | - Note that the userdata/ directory cannot be accessed using the browser, |
43 | (the "file attachments" or "documents and resources" plugins are recommended, though). |
166 | so if you need to use graphics, please specify a different path. |
- | |
167 | - | ||
168 | - | ||
169 | Folder "welcome" |
- | |
170 | ---------------- |
- | |
171 | - | ||
172 | The folder "welcome" contains the file "welcome.html", |
- | |
173 | which is the front page shown by the plugin "publicPages/000_objects". |
- | |
174 | You may edit this file to overwrite the default welcome page. |
- | |
175 | Please note: |
- | |
176 | - Since userdata/ is a protected directory, |
- | |
177 | you cannot place resources (images, css etc.) there. |
- | |
178 | - Although the file extension is ".html", it may only contain plain |
- | |
179 | HTML data (without head or body). |
- | |
180 | - | ||
181 | Internationalization: |
- | |
182 | To create a file with multiple languages, create them like this: |
- | |
183 | welcome.html <-- this is the file in the default language ("enus" = English USA) |
- | |
184 | welcome$dede.html <-- this is the file for German ("dede") |
- |