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

more info on scripts in utils folder

Browse Source
This commit is contained in:
Uwe Steinmann 2018-11-13 08:48:00 +01:00
parent 1592c794b0
commit 2d80dbce13
1 changed files with 31 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
utils/README.md
View File

@ -3,15 +3,12 @@ Running one of the scripts
Scripts in this folder are ment to be called on the command line by Scripts in this folder are ment to be called on the command line by
either executing one of the shell wrappers `seeddms-*` or by calling either executing one of the shell wrappers `seeddms-*` or by calling
`php -f <scriptname> -- <script options>`. `php -f <scriptname> -- <script options>`. Most scripts have an option
If you run the adddoc.php script make sure to run it with the permissions `-h` or `--help` which list the available script options.
of the user running your web server. It will copy files right into
your content directory of your SeedDMS installation. Don't do this Be aware that this scripts are not officially supported. Use them with
as root because you will most likely not be able to remove those documents care and always ensure to have a backup of your data before running
via the web gui. If this happens by accident, you will still be able any of them.
to fix it manually by setting the propper file permissions for the document
just created in your content directory. Just change the owner of the
document folder and its content to the user running the web server.
Do not allow regular users to run this scripts! Do not allow regular users to run this scripts!
----------------------------------------------- -----------------------------------------------
@ -19,3 +16,28 @@ Do not allow regular users to run this scripts!
None of the scripts do any authentication. They all run with a SeedDMS None of the scripts do any authentication. They all run with a SeedDMS
admin account! So anybody being allowed to run the scripts can modify admin account! So anybody being allowed to run the scripts can modify
your DMS content. your DMS content.
Adding documents
------------------
Single documents can be added with `seeddms-adddoc`. The script is just for
adding new documents but not for adding a new version. As the script is
just a small wrapper around the controller for adding documents by the web gui,
it will also trigger all hooks, but it will not send any notification to the
users.
If you run `seeddms-adddoc` make sure to run it with the permissions
of the user running your web server. It will copy files right into
the content directory of your SeedDMS installation. Don't do this
as root because you will most likely not be able to remove those documents
via the web gui. If this happens by accident, you will still be able
to fix it manually by setting the propper file permissions for the document
just created in your content directory. Just change the owner of the
document folder and its content to the user running the web server.
Indexing for fulltext search
-----------------------------
Instead of regulary updating the full text index from the web gui, you
can as well run `seeddms-indexer` in a cron job. It will either update
or recreate the full text index.