gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2025-11-27 18:10:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve formatting

Browse Source
This commit is contained in:
Uwe Steinmann 2025-10-23 17:44:48 +02:00
parent 30e4e6391a
commit 9a8477bf34
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/README.Dist-Layout
View File

@ -4,36 +4,39 @@ Layout of installation
SeedDMS allows various kinds of installations with very individual layouts SeedDMS allows various kinds of installations with very individual layouts
on disc. The proposed layout till version 5.1.6 was as the following: on disc. The proposed layout till version 5.1.6 was as the following:
```
seeddms51x ---+--- data seeddms51x ---+--- data
| |
+--- pear +--- vendor
| |
+--- seeddms-5.1.x +--- seeddms-5.1.x
| |
+--- www -> seeddms-5.1.x +--- www -> seeddms-5.1.x
```
'data' contains all document files, the sqlite database (if used), the full text `data` contains all document files, the sqlite database (if used), the full text
data, the log files, and the cached preview images. data, the log files, and the cached preview images.
'pear' contains all PEAR packages including the four SeedDMS packages SeedDMS_Core, `vendor` contains all third party packages including the four SeedDMS packages SeedDMS_Core,
SeedDMS_Lucene, SeedDMS_Preview, SeedDMS_SQLiteFTS. SeedDMS_Lucene, SeedDMS_Preview, SeedDMS_SQLiteFTS.
'seeddms-5.1.x' are the sources of seeddms and 'www' being a link on it. `seeddms-5.1.x` are the sources of seeddms and 'www' being a link on it.
This layout has disadvantages when updating the source of seeddms, because This layout has disadvantages when updating the source of seeddms, because
the directories 'conf' and 'ext' had to be moved from 'seeddms-5.1.x' to the directories `conf` and `ext` had to be moved from `seeddms-5.1.x` to
'seeddms-5.1.(x+1)'. 'conf' was also visible over the web unless it was `seeddms-5.1.(x+1)`. `conf` was also visible over the web unless it was
protected by an .htaccess file. The .htaccess file has been shipped, but it protected by an .htaccess file. The .htaccess file has been shipped, but it
is far better to keep senѕitive data out of the document root in the first is far better to keep senѕitive data out of the document root in the first
place. place.
The new layout mostly retains that structure but uses more soft links to place The new layout mostly retains that structure but uses more soft links to place
the local data outside of 'seeddms-5.1.x' which makes updating a lot easier the local data outside of `seeddms-5.1.x` which makes updating a lot easier
and moves the configuration out of the document root. and moves the configuration out of the document root.
As MS Windows does not support soft links, this change will only apply to Linux/Unix As MS Windows does not support soft links, this change will only apply to Linux/Unix
systems. MS Windows users just skip all the soft links and set seeddms-5.1.x systems. MS Windows users just skip all the soft links and set seeddms-5.1.x
as the document root. The new layout is the following: as the document root. The new layout is the following:
```
seeddms51x ---+--- data --+-- log seeddms51x ---+--- data --+-- log
| | | |
| +-- cache | +-- cache
@ -42,7 +45,7 @@ seeddms51x ---+--- data --+-- log
| | | |
| +-- ... | +-- ...
| |
+--- pear +--- vendor
| |
+--- conf +--- conf
| |
@ -73,10 +76,12 @@ seeddms51x ---+--- data --+-- log
+-- index.php -> ../seeddms/index.php +-- index.php -> ../seeddms/index.php
| |
+-- ext +-- ext
```
In order to convert to this layout you need to do the following in the seeddms51x In order to convert to this layout you need to do the following in the seeddms51x
directory (replace the 'x' in '5.1.x' with the correct number): directory (replace the 'x' in '5.1.x' with the correct number):
```
ln -s seeddms-5.1.x seeddms ln -s seeddms-5.1.x seeddms
mv www/conf . mv www/conf .
mv seeddms-5.1.x/ext www mv seeddms-5.1.x/ext www
@ -93,3 +98,4 @@ ln -s ../seeddms/webdav
ln -s ../seeddms/restapi ln -s ../seeddms/restapi
ln -s ../seeddms/pdfviewer ln -s ../seeddms/pdfviewer
ln -s ../seeddms/index.php ln -s ../seeddms/index.php
```