Timebeans is developed in Microsoft .Net Core which is one of the leading open-source platform and is supported on all major operating systems including Microsoft Windows, Linux and macOS. Timebeans uses MySQL as the backend database.
For a full list of all supported operating systems and version information please view this article.
Step-1: Please download and install the Microsoft ASP.Net Core Runtime for your platform using the link below:
For more options to download a runtime package please visit this page and choose your desired package from the "Runtime 2.1.6". Please note that Timebeans uses Microsoft .Net Core 2.1.6 and using any other version may not run the application smoothly and may result in inconsistent behaviour.
Step-2: Download and install the free MySQL Community Edition Server 8.0 (GPL license) for your platform.
Step-3: Download the Timebeans In-House edition software from the Timebeans website. The download link is included in the email you have received after the purchase. Alternatively you can visit the download page and download the Timebeans software for your platform. You would be required to enter your email address and license number. The license number is also included in the purchase email.
Step-4: The Timebeans download package is a compressed (.zip) file which contains three folders:
The "timebeans.webapp" is the web application and within it the file "Skavio.Web.dll" is the entry-point. The "timebeans-scheduler" is a scheduler which is responsible for scheduled jobs like sending emails for new users, invoices etc. And the "timebeans.database" has a SQL script which will create the MySQL database.
Step-5: Uncompress the main zip file and copy the "timebeans.webapp" folder to the location where you want to keep your web-folders (like on Windows "\inetpub\wwwroot\"). Similarly copy the "timebeans.scheduler" folder to an appropriate location. Under the "timebeans.database" folder there is a single file "timebeansdb.sql". Please execute this file for the MySQL database server either via the mysql command line or using any MySQL IDE like MySQL Workbench. MySQL Workbench can be downloaded using this link.
Step-6: Once the database is created please update its connection information in Timebeans web and scheduler applications. Please open the file "appsettings.json" in the "timebeans.webapp" folder and locate the "ConnectionStrings" section. Replace the keywords in upper-case (like "DATABASE-SERVER-ADDRESS", "DATABASE-NAME" etc.) with the correct values. Similarly, open the file "appsettings.json" in the "timebeans.scheduler" folder and replace the upper-case keywords with the correct values. The settings file in the "timebeans.scheduler" folder has additional keywords related with sending emails like "SMTP SERVER", "FROM EMAIL ADDRESS" etc. Please replace the keywords correctly. The "FROM EMAIL ADDRESS" is the email address which is used to send emails to new employees, customers etc.
Step-7: Follow the instructions in the article below to setup the server as per your environment and start using Timebeans:
- Installing Timebeans on Windows with IIS
- Installing Timebeans on Linux with Nginx
- Installing Timebeans on Linux with Apache
Step-8: Setup the scheduler so that the scheduled jobs can be run. On the Windows environment there is a file "Skavio.Scheduler.exe" in the "timebeans.scheduler" folder which needs to be executed after a fixed interval. Please use the Windows Task Scheduler to create a new Task and setup "Skavio.Scheduler.exe" to run repeatedly after a fixed interval (ideally every 5 minutes). Please go through this link for help on how to use Windows Task Scheduler for setting up an unattended task.
Similarly for Linux, please setup a cron job to repeatedly run "Skavio.Scheduler.dll" on a fixed interval. Please go through this link for help on how to create cron jobs in Linux.