Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 3.51 KB

shared-hosting.md

File metadata and controls

42 lines (26 loc) · 3.51 KB
Raw

Shared Hosting Installation

It is essential to ensure that your hosting provider meets all necessary requirements prior to proceeding with the installation. This will help to ensure a smooth and successful implementation.

1. Requirments

2. Passky Server Installation

⚠️ It is important to note that when installing the Passky Server, only the data contained within the server/src folder should be made publicly accessible. Any other data should be kept secure and protected.

  1. To begin the installation process for the Passky Server, navigate to the root directory of your hosting, download the Passky Server and save it in a folder named Passky-Server.

  2. In order to prepare the server for the installation process, open a terminal and navigate to the Passky-Server folder by executing the command: cd Passy-Server. Then execute the following commands in sequence:

./installer.sh # or just copy `.env.example` into `server/.env` and make the proper changes that suit you.
./shared-hosting-finalization.sh

  1. To ensure proper functionality, it is necessary to create a sub-domain, passky.yourdomain.com, that points to the Passky-Server/server/src directory.

  2. Execute the /cron.php API endpoint at least once. This is crucial as it will create necessary tables if they do not already exist. To ensure ongoing maintenance, configure your hosting provider's cron job scheduler to run this endpoint at least once per day.

  3. Upon completion of the installation process, the admin panel for the Passky Server can be accessed via the URL passky.yourdomain.com. Additionally, various clients such as the Desktop Application, Web Browser, Browser Extension, and Android Application can be connected to the Passky Server.

3. Passky Website Installation (Optional)

ℹ️ The Passky Website is a client-side only application and as such, it does not require any server-side code for its operation. As a result, it can be hosted for free on Cloudflare Pages.

  1. Create a sub-domain specifically for the Passky Website, for example, vault.yourdomain.com.

  2. Once the sub-domain is created, a new folder should appear in the root directory, named vault or vault.yourdomain.com.

  3. Download the latest version of the Passky Website from the official GitHub repository and extract it to the previously created folder.

  4. Access the URL vault.yourdomain.com to view the newly installed Passky Website. It is recommended to verify that the website is functional and that all required components are properly configured.

⚠️ When deploying the Passky Website, it is essential to ensure that appropriate security measures are in place. If not utilizing Cloudflare Pages, it is recommended that all relevant security headers are properly implemented to protect against potential vulnerabilities.