Skip to content

Gauzy Server

Ruslan K edited this page Feb 10, 2024 · 4 revisions

Ever Gauzy Server

  • Download the latest release of Ever Gauzy Server for your OS from GitHub releases page https://github.com/ever-co/ever-gauzy-server/releases or from the official downloads page https://gauzy.co/downloads.
  • Run Gauzy Server setup file (e.g. https://github.com/ever-co/ever-gauzy-server/releases/download/v0.450.5/gauzy-server-0.450.5.exe for Windows OS).
  • You can select all defaults, i.e. "SQLite" DB, and "Default" port. Click "Save," and after a couple of seconds (or minutes, depending on your computer performance), it will create a local SQLite DB. Note: it is recommended to use PostgreSQL instead of SQLite for production setup!
  • Please follow the Custom Domain & SSL Certificate guide if you need setup Gauzy Server on your custom domain with SSL certificate.
  • Gauzy Server is ready to use.
  • You can connect to Gauzy Server from your browser on http://localhost:8084. You can replace localhost with your Server IP or Domain if you connecting from an external device.
  • You can install Gauzy Desktop App and configure it to connect to the Gauzy Server API on http://localhost:5620/api. You can replace localhost with your Server IP or Domain if you connecting from an external device.
  • Login with admin@ever.co and password admin to check Admin functionality. Note: an Admin user is not an employee, so you can't track time with this user!
  • You can login with employee@ever.co and password 123456 to check Desktop Timer and other functionality from the "Employee" perspective (such a user is an Employee of the default organization/tenant).

Note: to be able to connect to Gauzy Server from an external network, you need to enable access via firewall on port 8084 (for UI) and port 5620 for API.

Building Manually

If you want to build a Server manually, you need to run one of the following commands from the root of mono-repo:

  • yarn build:gauzy-server:windows for Windows
  • yarn build:gauzy-server:mac for Mac
  • yarn build:gauzy-server:linux for Linux

After the build is finished, you can find binary packages in the dist/apps/gauzy-server folder.

Troubleshooting

Windows

Check logs in C:\Users\YOUR_USER_NAME\AppData\Roaming\gauzy-server\logs\main.log file.

Legal Notice

The links to third-party software are being provided as a convenience and for informational purposes only; they do not constitute an endorsement or approval of any of the products, services, or opinions of the corporation or organization, or individual. Ever Co. LTD bears no responsibility for the accuracy, legality, or content of the external sites or applications or for subsequent links. Contact the external site or application vendor for answers to questions regarding its content.