-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Lars Geyer-Blaumeiser edited this page Mar 17, 2022
·
23 revisions
- Version 1.0 - 2018-08-08
- Version 1.1 - 2018-08-12
- Version 1.2 - 2018-08-31
- Version 1.3 - 2018-12-03
- Version 1.4 - 2019-01-02
- Version 1.5 - 2019-03-31
- Version 1.5.1 - 2019-04-07
- Version 1.5.2 - 2019-05-01
- Version 1.6 - 2020-11-16
- Version 1.6.1 - 2020-12-23
- Version 1.7 - 2022-03-17
- Prerequisite: You need a docker and docker-compose installed in a quite recent version
- Download the ptm_1.6.1.zip file from the release page above and unzip it to a folder
- Go inside the folder and run the install.sh script, the script will copy the files to an installation folder, and, if selected, restores the data using the restore feature
- You need to re-source your shell, to ensure all variables are reset properly
The overview app can be reached under http://localhost:27727/overview to show the booking data for today. If you want to see the data of a prior day, use http://localhost:27727/overview/yyyy-MM-dd. The url depends on the server where you have started the backend, here assumed the localhost and of course on the port you selected, here the standard port of the docker_compose deployment.
The HTML overview app shows the booking data of the selected day and runs the project analysis on the day. In addition, the app shows the Project and Hour Analysis of the month and lists all activities. There is no interaction with the shown data, it is read only information.
Usage: ptm [options] [command] [command options] Options: -h, --help
Commands: add_activity(aa) Define a new activity for bookings Usage: add_activity(aa) [options] Options: * -pn, --project-name Name of the overall project * -pi, --project-id Project identifier * -an, --activity-name Name of the activity * -ai, --activity-id Activity id
change_activity(ca) Change an existing activity for bookings Usage: change_activity(ca) [options] Options: * -a, --activity Id of activity to change -pn, --project-name Change the name of the overall project -pi, --project-id Change the project id -an, --activity-name Change the name of the activity -ai, --activity-id Change the activity id --hidden Hide the activity --visible Make activity visible, if hidden list_activities(la) List all activities available Usage: list_activities(la) [options] Options: --hidden Show hidden activities register_user(ru) Register a new user Usage: register_user(ru) [options] Options: * -u, --username Username of new user * -p, --password Password of new user * -e, --email Email address of new user * -q, --question Question for password reset of new user * -a, --answer Answer for question on password reset set_user(se) Set the user to be used in cli and store it encrypted in local config Usage: set_user(se) [options] Options: * -u, --username Username of the user * -p, --password Password of the user change_password(cp) Change the password of the currently set local user in backend Usage: change_password(cp) [options] Options: * -p, --password New Password of the user reset_password(rp) Reset the password for a user and set it locally Usage: reset_password(rp) [options] Options: * -u, --username Username of the user * -a, --answer Answer for question on password reset delete_user Delete the currently set user Usage: delete_user [options] Options: * --confirm Explicitely requested, since action deletes all user data show_user(su) Show user data for the currently set local user Usage: show_user(su) add_booking(ab) Add a new booking Usage: add_booking(ab) [options] Options: * -a, --activity Activity id of the bookings activity -d, --day Optional day for booking, either a iso date format or -<days> * -s, --starttime Start time of the booked time frame -e, --endtime End time of the booked time frame -c, --comment Comment on booked time frame delete_booking(db) Delete an existing booking Usage: delete_booking(db) [options] Options: * -b, --booking Booking id of the booking to end change_booking(cb) Changes properties of an existing booking Usage: change_booking(cb) [options] Options: * -b, --booking Booking id of the booking to end -a, --activity Activity id of the bookings activity -s, --starttime Start time of the booked time frame -e, --endtime End time of the booked time frame -c, --comment Comment on booked time frame add_break(br) Add a break to an existing booking Usage: add_break(br) [options] Options: * -b, --booking Booking id of the booking to end * -s, --starts-at Insert break at the given time -l, --length Length of the break, default is 30 minutes list_bookings(lb) List all bookings of a day Usage: list_bookings(lb) [options] Options: -d, --day Optional day for bookings, either a iso date format or -<days> hour_analysis(ha) Run an hour analysis for a month Usage: hour_analysis(ha) [options] Options: -d, --day Day for analysis, either a iso date format or -<days> -w, --week Day in week for analysis -m, --month Month for the analysis -s, --period-start Start day of period -e, --period-end First day after the period activities_analysis(ac) Run an analysis activities to hours, separated for all single activities for a month or a day Usage: activities_analysis(ac) [options] Options: -d, --day Day for analysis, either a iso date format or -<days> -w, --week Day in week for analysis -m, --month Month for the analysis -s, --period-start Start day of period -e, --period-end First day after the period projects_analysis(pa) Run an analysis projects to hours for all projects aggregating activities with same project id Usage: projects_analysis(pa) [options] Options: -d, --day Day for analysis, either a iso date format or -<days> -w, --week Day in week for analysis -m, --month Month for the analysis -s, --period-start Start day of period -e, --period-end First day after the period backend Boot the backend, requires an existing docker-compose installation in version 1.22.0 or higher Usage: backend [options] Options: --start Start the backend --status Check status of the backend --stop Stop the backend backup Backup all bookings, activities and users into zip file Usage: backup [options] Options: * -z, --zipfile Name of zipfile to store the data restore Restore a backup from a zip file Usage: restore [options] Options: * -z, --zipfile Name of zipfile to store the data licenses Show license information for cli and backend Usage: licenses