{"id":19408499,"url":"https://github.com/ladybirdweb/faveo-helpdesk-docker-v2","last_synced_at":"2025-04-14T10:04:10.866Z","repository":{"id":93320007,"uuid":"320185142","full_name":"ladybirdweb/faveo-helpdesk-docker-v2","owner":"ladybirdweb","description":"Docker image for running latest version of Faveo Helpdesk","archived":false,"fork":false,"pushed_at":"2025-02-06T10:32:43.000Z","size":45,"stargazers_count":1,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-14T10:03:33.232Z","etag":null,"topics":["helpdesk","helpdesk-ticketing","helpdesk-tools"],"latest_commit_sha":null,"homepage":"https://www.faveohelpdesk.com","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ladybirdweb.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-10T06:50:13.000Z","updated_at":"2025-02-06T10:32:47.000Z","dependencies_parsed_at":"2024-11-17T15:24:50.846Z","dependency_job_id":"f8bc86f3-2276-412a-b32d-faf27ec7d2bd","html_url":"https://github.com/ladybirdweb/faveo-helpdesk-docker-v2","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybirdweb%2Ffaveo-helpdesk-docker-v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybirdweb%2Ffaveo-helpdesk-docker-v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybirdweb%2Ffaveo-helpdesk-docker-v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybirdweb%2Ffaveo-helpdesk-docker-v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ladybirdweb","download_url":"https://codeload.github.com/ladybirdweb/faveo-helpdesk-docker-v2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248860299,"owners_count":21173342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helpdesk","helpdesk-ticketing","helpdesk-tools"],"created_at":"2024-11-10T12:06:23.396Z","updated_at":"2025-04-14T10:04:10.843Z","avatar_url":"https://github.com/ladybirdweb.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\n# \u003cb\u003eDeploying Faveo Helpdesk on Docker\u003c/b\u003e   \u003c!-- omit in toc --\u003e\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/4/4e/Docker_%28container_engine%29_logo.svg/440px-Docker_%28container_engine%29_logo.svg.png\" alt=\"drawing\" width=\"300\"/\u003e\n\n## \u003cb\u003eFaveo Helpdesk Docker\u003c/b\u003e\n\nA pretty simplified Docker Compose workflow that sets up a network of containers for Faveo Helpdesk.\n\nAll the Faveo Helpdesk editions are supported except the community edition.\n\n## \u003cb\u003eUsage\u003c/b\u003e\n___\n\nTo get started, make sure you have Docker and Docker-Compose installed on your system, and then clone the below Git-Hub repository with the below link.\n\n```sh\ngit clone https://github.com/ladybirdweb/faveo-helpdesk-docker-v2.git\n```\n\n---\nNext, navigate in your terminal to the directory you cloned this, and give the executable permissions to bash scripts.\n\n#### For all Faveo Editions (except community edition).\n\n```sh\nchmod +x faveo-run.sh\n```\n\n#### For Faveo Community Edition.\n\n```sh\nchmod +x faveo-community-run.sh\n```\n---\n\n### \u003cb\u003ePrerequisites To run the script:\u003c/b\u003e\n\n1. A valid domain name fully propagated to your Server's IP.\n2. Sudo Privilege.\n3. Faveo license and Order number. (This can be obtained from \u003ca href=\"https://billing.faveohelpdesk.com\" target=\"_blank\" rel=\"noopener\"\u003ebilling.faveohelpdesk.com\u003c/a\u003e).\u003cb\u003e (This is not required for Community Edition)\u003c/b\u003e\n4. Unreserved ports 80 and 443. (If it is reserved feel free to edit and change the ports of your choice in docker-copompose.yml)\n5. Operating Systems Ubuntu 20,22,24\n6. SSL Certificate (For Paid SSL Users), If you're using a paid SSL, have the SSL certificate files ready before installation.\n\n---\n\nComplete the below steps to get the Containers up.\n\n---\n\n#### \u003cb\u003eFor all Faveo Editons (except community edition).\u003c/b\u003e\n\nRun the script \u003ccode\u003e\u003cb\u003efaveo-run.sh\u003c/b\u003e\u003c/code\u003e by passing the necessary arguments.\n\n**NOTE:** You should have a Valid domain name pointing to your public IP. This domain name is used to obtain SSL certificates, and the mail is used for the same purpose. The license code and Order Number can be obtained from your Faveo Helpdesk Billing portal, and make sure not to include the '#' character in the Order Number.\n\n**SSL Certificate Options:** Pass the option based on your SSL requirement\n\n- Option A: Let’s Encrypt (Free SSL)\n\n- Option B: Self-Signed SSL\n\n- Option C: Paid SSL (\n  \n  Incase of Paid SSL, please ensure your SSL files are ready in your system. If you choose Option C (Paid SSL), you must specify the paths of the SSL certificate files.\n\nSSL Certificate Path: */path/to/certificate.crt*\n\nSSL Key Path: */path/to/private.key*\n\nSSL CA Bundle : */path/to/ca_bundle.crt*\n\nUsage:\n```sh\n ./faveo-run.sh -domainname \u003cyour domainname\u003e -email \u003cexample@email.com\u003e -license \u003cfaveo license code\u003e -orderno \u003cfaveo order number\u003e -ssl \u003cSSL Option\u003e\n```\nExample: It should look something like this.\n```sh\n ./faveo-run.sh -domainname berserker.tk -email berserkertest@gmail.com -license 5H876********** -orderno 8123****** -ssl \u003cA|B|C\u003e\n```\n---\n\n#### \u003cb\u003eFor Faveo Community Edition.\u003c/b\u003e\n\nRun the script \u003ccode\u003e\u003cb\u003efaveo-communtiy-run.sh\u003c/b\u003e\u003c/code\u003e  by passing the necessary arguments.\n\n**NOTE:** You should have a Valid domain name pointing to your public IP. This domain name is used to obtain SSL certificates, and the mail is used for the same purpose.\n\n\n**SSL Certificate Options:** Pass the option based on your SSL requirement\n\n- Option A: Let’s Encrypt (Free SSL)\n\n- Option B: Self-Signed SSL\n\n- Option C: Paid SSL (\n  \n  Incase of Paid SSL, please ensure your SSL files are ready in your system. If you choose Option C (Paid SSL), you must specify the paths of the SSL certificate files.\n\nSSL Certificate Path: */path/to/certificate.crt*\n\nSSL Key Path: */path/to/private.key*\n\nSSL CA Bundle : */path/to/ca_bundle.crt*\n\n\n\nUsage:\n```sh\n ./faveo-community-run.sh -domainname \u003cyour domainname\u003e -email \u003cexample@email.com\u003e -ssl \u003cSSL Option\u003e\n```\nExample: It should look something like this.\n```sh\n ./faveo-community-run.sh -domainname berserker.tk -email berserkertest@gmail.com -ssl \u003cA|B|C\u003e\n```\n\n---\n\nAfter the docker installation is completed you will be prompted with Database Credentials and Credentials are saved in filename \u003ccode\u003e\u003cb\u003ecredentials.txt\u003c/b\u003e\u003c/code\u003e  them somewhere safe and a cronjob will be set to auto-renew SSL certificates from Letsencrypt.\n\nVisit  \u003ccode\u003e\u003cb\u003ehttps://yourdomainname.com\u003c/b\u003e\u003c/code\u003e complete the readiness probe, input the Database Details when prompted, and complete the installation.\n\nThere is one final step that needs to be done to complete the installation. \n\nYou have to edit the \u003ccode\u003e\u003cb\u003e.env\u003c/b\u003e\u003c/code\u003e file which is generated under the Faveo root directory after completing the installation in the browser. \n\nOpen the terminal and navigate to the faveo-docker directory here you will find the directory \u003ccode\u003e\u003cb\u003efaveo\u003c/b\u003e\u003c/code\u003e which is downloaded while running the script this directory contains all the Helpdesk codebase, inside it, you need to edit the \u003ccode\u003e\u003cb\u003e.env\u003c/b\u003e\u003c/code\u003e  file and add \u003ccode\u003e\u003cb\u003eREDIS_HOST=faveo-redis\u003c/b\u003e\u003c/code\u003e. The \"faveo-redis\" is the DNS name of the Redis container. \n\nFinally, run the below command for changes to take effect.\n\nFor LetsEncrypt SSL \u0026 Paid SSL\n\n```sh\ndocker compose down \u0026\u0026 docker compose up -d\n```\n\nOnly For Self-Signed SSL\n\n```sh\nchmod +x composedownup.sh\n./composedownup.sh*\n```\n---\n---\n\n\u003cp class=\"notice--warning\"\u003e\nNote: At this point, the helpdesk interface will not load in the browser. To finalize the installation, you need to remove specific entries from the database.\n\u003c/p\u003e\n\n- Access your MariaDB container using the following command:\n\n```\n docker exec -it YourDomain-mariadb /bin/bash\n```\nReplace \u003ccode\u003e\u003cb\u003eYourDomain\u003c/b\u003e\u003c/code\u003e by the actual domain name.\n\n- Enter the database by executing:\n\n```\nmysql -u root -pYourPassword\nuse faveo;\n```\n\n- Remove the necessary entry from the plugins table:\n\n```\nDELETE FROM plugins WHERE name = '';\n```\n\nOnce the entry is removed, you can access the helpdesk via the browser and continue using it.\n\n---\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybirdweb%2Ffaveo-helpdesk-docker-v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fladybirdweb%2Ffaveo-helpdesk-docker-v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybirdweb%2Ffaveo-helpdesk-docker-v2/lists"}