X-Git-Url: https://dev.renevier.net/gitweb.cgi?p=syp.git;a=blobdiff_plain;f=README.txt;h=7bad6cf8fa9c8d1d982f120e82c83b7396020ce8;hp=b1f096fe180bf68fd7a2c8547a54e9cb7f1c1b44;hb=1eff14d093d541d9858f73ffca042de5a2bf3ea5;hpb=7282fabcfef34ef95b8c6bd414f34d77037451e1 diff --git a/README.txt b/README.txt index b1f096f..7bad6cf 100644 --- a/README.txt +++ b/README.txt @@ -14,9 +14,63 @@ Requirements Installation ------------ -edit inc/settings.php -open http://yoururl.com/wizard.php -follow instructions + +* manual configuration + + - edit `inc/settings.php.in` and copy it to `inc/settings.php` + - upload syp to your webserver + - open http://yoururl.com/install.php with your web browser to finalize + installation (database tables creation). + +* automatic configuration + - upload syp to your webserver + - open http://yoururl.com/install.php with your web browser and follow + instructions. + +For automatic configuration to work, `inc/` directory needs to be writeable. Use +`chmod` to set the appropriate directory permissions. If in doubt, `chmod` to +`0777`. Alternatively, you can use manual method. + +Some advanced configuration options are not available with automatic method. If +you need to set those options, use manual configuration. + +Upgrade +------------ +- make a copy of `inc/settings.php` +- make a copy of `upload/` (or directory where your photos and thumbnails are stored). +- delete old version of syp from your server +- upload new version +- edit `inc/settings.php` again (copy old version of file may not be enough + because new settings may have appeared) +- copy `upload/` back. +- open http://yoururl.com/upgrade.php with your web browser + +co-administrators +----------------- +It is possible to allow other people to upload and manage +pictures/descriptions. In admin interface, select "Add an co-administrator" +and fill informations (user name and password). Then, you need to communicate +to your user its username and password. He/She will be able to modify this +password afterward. Only admin can add new users. + +Other co-administrators will be able to add markers, and delete/modifiy them. +They cannot modify markers they have not created. admin is the only user +allowed to manage markers of other users. If you plan to have several +co-administrators, you may want to create a normal user for yourself, and use +it to manage your markers. You will then only use admin account when really +needed. + +Currently, SYP does not allow + +server API +---------- +Client/server communication follows an API. This allow for example creation of +scripts to automate some tasks. [API description] [1] is mainly aimed at +developers and inquiring people. You should not need it if you just want to +install syp on your website. + +[1]: http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt + Author ------