1,184 → 1,43 |
|
The folder "userdata" contains various files that are unique |
to your OIDplus installation. With a few exceptions (like this file), |
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 "userdata" belongs to you, |
and everything else belongs to OIDplus (and should not be changed). |
Generally speaking, everything inside these folders belongs to you, |
and everything else belongs to OIDplus (and should not be changed!). |
|
Since this folder can also contain sensitive information |
like log files or a SQLite database, the access to this |
directory must be restricted. Therefore, please make sure |
that your webserver (e.g. Apache) does not allow access |
to this directory. |
|
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). |
|
Various plugins can put their data in this directory. |
Here is a list of typical sub-folders: |
More information about the contents of the sub-folders |
can be found in the info.txt file which is located in |
each sub-folder. |
|
|
Folder "attachments" |
-------------------- |
The folder "userdata_pub" |
------------------------- |
|
Used by the plugin "publicPages/095_attachments". |
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. |
|
Contents: |
- userdata/attachments/filetypes.conf (optional) to define/overwrite fileformat descriptions placed in 3p/vts_fileformats/filetypes.conf |
- Folders with attachments users have uploaded. |
|
Example for folder names: |
oid_2_999: for a normal OID |
oid_1_3_6_1_4_1_37476_30_9_<sysid>_<smallhash>: for a non-OID object |
If your system does not have a public key / system ID (e.g. because of missing OpenSSL), the names are |
oid_2_999: for a normal OID |
oid_2_25_<...>: for a GUID |
<md5hash>: for other non-OID objects |
|
In order for the file attachment upload to work, |
you need to adjust the folder permissions. |
For example, on Linux "chown" to the user "www-data" or "chmod" to "0777". |
|
|
Folder "baseconfig" |
------------------- |
|
The folder "baseconfig" contains the file "config.inc.php" which defines |
important static settings like the database connection credentials or |
security keys (ReCaptcha) etc. |
Setup (/setup/) will show assist you in creating this config.inc.php file. |
|
|
Folder "database" |
----------------- |
|
This folder can be used to store a SQLite database. |
The default database name is" oidplus.db" |
|
|
Folder "favicon" |
---------------- |
|
If the file favicon.ico is existing, it will be chosen instead of img/favicon.ico |
|
|
Folder "logs" |
------------- |
|
Contains the file oidplus.log created by plugin "logger/300_userdata_logfile". |
Having log messages stored in the log files makes |
processing of data easier. For example you can use "fail2ban" to |
analyze the log file and automatically ban IP addresses of networks |
that try to brute force an user account password. |
|
Note: |
- Make sure that oidplus.log can be written by your webserver (e.g. Apache). |
- You can shrink the size of oidplus.log by using logrotate (only Linux) |
|
|
Folder "resources" |
------------------ |
|
This folder is used by the plugin "publicPages/500_resources" |
(Section "Documents and resources") |
|
Its contents will be merged with "res/" from the root directory. |
"res/" contains the default resources which are part of the OIDplus |
main installation (you shall not change or add anything to that folder), |
while "userdata/resources" contains resources that you add yourself |
(e.g. your impress, privacy statement, additional resources, |
hyperlinks to your websites and products, etc.) |
|
Valid contents: |
- Subfolders |
- *.html files |
- *.link files (will be converted to a hyperlink in the menu on the left) |
- *.url files (will be converted to a hyperlink in the menu on the left. |
No internationalization possible, therefore deprecated!) |
|
Icons: |
You can define custom icons for any any file or folder by placing PNG files |
with the following file names: |
|
Assume the ressource file <filename>.html , then the icon files are: |
<filename>_big.png (Big icon in the content-pane) |
<filename>_big$dede.png (German-specific icon) |
<filename>_tree.png (Icon in the tree view, 16x16) |
<filename>_tree$dede.png (German-specific tree icon) |
|
The same applies for folders. |
|
Internationalization of *.html files: |
Title: The title is taken from the HTML headline. |
To create a file with multiple languages, create them like this: |
example.html <-- this is the file in the default language ("enus" = English USA) |
example$dede.html <-- this is the file for German ("dede") |
Attention: The main file (without language code) needs to exist, so this is NOT possible: |
example$enus.html <-- DO NOT USE |
example$dede.html |
|
Internationalization of *.link files: |
Title: |
.link files are like .url files, but they have an attribute for defining a title. |
The file format is like this: |
[Link] |
Title="Report a bug" |
URL="https://www.viathinksoft.com/thinkbug/thinkbug.php?id=97" |
To create an URL with multiple languages, create them like this: |
example.link <-- this is the file in the default language ("enus" = English USA) |
example$dede.link <-- this is the file for German ("dede") |
Attention: The main file (without language code) needs to exist, so this is NOT possible: |
example$enus.link <-- DO NOT USE |
example$dede.link |
|
Internationalization of *.url files: |
.url files are the normal files that can be created using Microsoft Windows. |
Internationalization of *.url files is not possible. |
Title: |
The title is taken from the file name. |
You need to create two entries which are always both visible in the menu, |
independent from the chosen language: |
- "Report a bug.url" |
- "Einen Fehler melden.url" |
|
Internationalization of Folder names: |
By default, the folder title is the name of the directory. |
To change it, you can place a folder.ini with the following contents: |
[Folder] |
Title="Object Identifiers" |
For multilinguality, e.g. create folder$dede.ini for a German name |
[Folder] |
Title="Objekt-Bezeichner (OID)" |
Please note that the URL is always the same and exposes the real directory name: |
...?goto=oidplus:resources$Object Identifiers/ |
|
|
Folder "styles" |
--------------- |
|
In this folder, you can place an alternative version of oidplus_base.css and setup_base.css. |
|
ATTENTION: |
- You need to make sure that your changes are in-sync with the current versions |
of oidplus_base.css and setup_base.css! |
- Note that the userdata/ directory cannot be accessed using the browser, |
so if you need to use graphics, please specify a different path. |
|
|
Folder "welcome" |
---------------- |
|
The folder "welcome" contains the file "welcome.html", |
which is the front page shown by the plugin "publicPages/000_objects". |
You may edit this file to overwrite the default welcome page. |
Please note: |
- Since userdata/ is a protected directory, |
you cannot place resources (images, css etc.) there. |
- Although the file extension is ".html", it may only contain plain |
HTML data (without head or body). |
|
Internationalization: |
To create a file with multiple languages, create them like this: |
welcome.html <-- this is the file in the default language ("enus" = English USA) |
welcome$dede.html <-- this is the file for German ("dede") |
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). |