āļŠāļĢāđ‰āļēāļ‡āđ‚āļ›āļĢāđ€āļˆāļāļ•āđŒÂķ

āļ•āļīāļ”āļ•āļąāđ‰āļ‡āđāļžāļĨāļ•āļŸāļ­āļĢāđŒāļĄÂķ

  1. Visit NightPOS.sh and click Deploy your platform.

    The Deploy your platform button on NightPOS.sh
  2. āđ€āļ‚āđ‰āļēāļŠāļđāđˆāļĢāļ°āļšāļšāļ”āđ‰āļ§āļĒāļšāļąāļāļŠāļĩ GitHub

    āļāļēāļĢāđ€āļ‚āđ‰āļēāļŠāļđāđˆāļĢāļ°āļšāļš GitHub
  3. Authorize NightPOS.sh by clicking Authorize nightpos twice.

    Granting NightPOS.sh permissions to perform actions and access data on GitHub Granting NightPOS.sh additional permissions to perform actions and access data on GitHub

    Note

    NightPOS.sh requests GitHub to:

    • āđ€āļ‚āđ‰āļēāļ–āļķāļ‡āļ‚āđ‰āļ­āļĄāļđāļĨāļāļēāļĢāđ€āļ‚āđ‰āļēāļŠāļđāđˆāļĢāļ°āļšāļšāđāļĨāļ°āļ­āļĩāđ€āļĄāļĨ GitHub āļ‚āļ­āļ‡āļ„āļļāļ“

    • āļŠāļĢāđ‰āļēāļ‡ repository āđƒāļŦāļĄāđˆ āđƒāļ™āļāļĢāļ“āļĩāļ—āļĩāđˆāļ„āļļāļ“āđ€āļĢāļīāđˆāļĄāļ•āđ‰āļ™āļˆāļēāļāļĻāļđāļ™āļĒāđŒ

    • āđ€āļ‚āđ‰āļēāļ–āļķāļ‡ repositories āļ—āļĩāđˆāļĄāļĩāļ­āļĒāļđāđˆ āļĢāļ§āļĄāļ–āļķāļ‡āļ‚āļ­āļ‡ organization āđƒāļ™āļāļĢāļ“āļĩāļ—āļĩāđˆāļ„āļļāļ“āđ€āļĢāļīāđˆāļĄāļ•āđ‰āļ™āļˆāļēāļ repository āļ—āļĩāđˆāļĄāļĩāļ­āļĒāļđāđˆ

    • āļŠāļĢāđ‰āļēāļ‡ webhook āđ€āļžāļ·āđˆāļ­āđāļˆāđ‰āļ‡āđ€āļ•āļ·āļ­āļ™āļ„āļļāļ“āļ—āļļāļāļ„āļĢāļąāđ‰āļ‡āļ—āļĩāđˆāļĄāļĩāļāļēāļĢ push āļāļēāļĢāđ€āļ›āļĨāļĩāđˆāļĒāļ™āđāļ›āļĨāļ‡

    • commit āļāļēāļĢāđ€āļ›āļĨāļĩāđˆāļĒāļ™āđāļ›āļĨāļ‡āđ€āļžāļ·āđˆāļ­āđƒāļŦāđ‰āļāļēāļĢāļ•āļīāļ”āļ•āļąāđ‰āļ‡āļ‡āđˆāļēāļĒāļ‚āļķāđ‰āļ™

  4. āļāļĢāļ­āļāđāļšāļšāļŸāļ­āļĢāđŒāļĄ Deploy your platform āđāļĨāļ°āļ„āļĨāļīāļ Deploy:

    • Github repository: āđ€āļžāļ·āđˆāļ­āļŠāļĢāđ‰āļēāļ‡āļžāļ·āđ‰āļ™āļ—āļĩāđˆāđ€āļāđ‡āļšāļ‚āđ‰āļ­āļĄāļđāļĨāđƒāļŦāļĄāđˆ āđƒāļŦāđ‰āđ€āļĨāļ·āļ­āļ New repository āđāļĨāļ°āļ›āđ‰āļ­āļ™āļŠāļ·āđˆāļ­ āđ€āļžāļ·āđˆāļ­āđƒāļŠāđ‰āļžāļ·āđ‰āļ™āļ—āļĩāđˆāđ€āļāđ‡āļšāļ‚āđ‰āļ­āļĄāļđāļĨāļ—āļĩāđˆāļĄāļĩāļ­āļĒāļđāđˆ āđƒāļŦāđ‰āđ€āļĨāļ·āļ­āļ Existing repository āđāļĨāļ°āđ€āļĨāļ·āļ­āļāļžāļ·āđ‰āļ™āļ—āļĩāđˆāđ€āļāđ‡āļšāļ‚āđ‰āļ­āļĄāļđāļĨāļ™āļąāđ‰āļ™

    • NightPOS Version: select the major version of NightPOS you want to use.

      Tip

      • Use the latest major version of NightPOS version when creating a new repository. If you are planning to import an existing database or applications, it might be required that their versions match.

      • If you are starting on NightPOS Online and plan to migrate to NightPOS.sh later, create your database using nightpos.com/start-lts to ensure compatibility, as minor versions are not supported by NightPOS.sh.

    • Subscription Code: enter your NightPOS Enterprise subscription code that includes NightPOS.sh. It is also sometimes called the subscription referral, contract number, or activation code.

      Tip

      Partners can use their partnership codes to initiate a trial (trial builds are limited to 1 GB storage and two staging). If a client proceeds to start a project, they must subscribe to an NightPOS Enterprise plan that includes NightPOS.sh hosting and use their subscription code.

    • Hosting location: āđ€āļĨāļ·āļ­āļāļ āļđāļĄāļīāļ āļēāļ„āļ—āļĩāđˆāđāļžāļĨāļ•āļŸāļ­āļĢāđŒāļĄāļ‚āļ­āļ‡āļ„āļļāļ“āļˆāļ°āļ–āļđāļāđ‚āļŪāļŠāļ•āđŒ

    āđāļšāļšāļŸāļ­āļĢāđŒāļĄ Deploy your platform

āļ™āļģāđ€āļ‚āđ‰āļēāļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨÂķ

Once your platform is deployed, you can import a database into your NightPOS.sh project, provided it uses a supported version of NightPOS.

Note

Due to NightPOS's backup policy, the import process requires four times the size of your database dump in available storage. For example, a 10 GB dump file will require at least 40 GB of available space. We recommend allocating more than four times× the dump size temporarily, then reducing storage after the import is complete.

āļŦāļēāļāđ‚āļ›āļĢāđ€āļˆāļāļ•āđŒāļ‚āļ­āļ‡āļ„āļļāļ“āđ€āļ›āđ‡āļ™āļāļēāļĢāļ—āļ”āļĨāļ­āļ‡āđƒāļŠāđ‰āļ—āļĩāđˆāļŠāļĢāđ‰āļēāļ‡āļ”āđ‰āļ§āļĒāļĢāļŦāļąāļŠāļžāļēāļĢāđŒāļ—āđ€āļ™āļ­āļĢāđŒ āļ„āļļāļ“āļŠāļēāļĄāļēāļĢāļ–āļ™āļģāđ€āļ‚āđ‰āļēāđ„āļŸāļĨāđŒāļ”āļąāļĄāļžāđŒāļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļ—āļĩāđˆāļĄāļĩāļ‚āļ™āļēāļ”āđ„āļĄāđˆāđ€āļāļīāļ™ 1 GB āđ€āļ—āđˆāļēāļ™āļąāđ‰āļ™

āļžāļļāļŠāđ‚āļĄāļ”āļđāļĨāđ„āļ›āļĒāļąāļ‡ productionÂķ

āļŦāļēāļāļ„āļļāļ“āđƒāļŠāđ‰āđ‚āļĄāļ”āļđāļĨāļŠāļļāļĄāļŠāļ™āļŦāļĢāļ·āļ­āđ‚āļĄāļ”āļđāļĨāļ—āļĩāđˆāļāļģāļŦāļ™āļ”āđ€āļ­āļ‡ āđƒāļŦāđ‰āđ€āļžāļīāđˆāļĄāđ‚āļĄāļ”āļđāļĨāđ€āļŦāļĨāđˆāļēāļ™āļąāđ‰āļ™āđ„āļ›āļĒāļąāļ‡āļŠāļēāļ‚āļēāđƒāļ™āļžāļ·āđ‰āļ™āļ—āļĩāđˆāđ€āļāđ‡āļšāļ‚āđ‰āļ­āļĄāļđāļĨ GitHub āļ‚āļ­āļ‡āļ„āļļāļ“

Note

Databases hosted on NightPOS Online do not support custom modules.

NightPOS.sh automatically detects folders containing NightPOS modules. You can organize them however you prefer. For example, you can place them directly in the root directory of your repository or group them by category (e.g., accounting, project, etc.).

āļŠāļģāļŦāļĢāļąāļšāđ‚āļĄāļ”āļđāļĨāļŠāļļāļĄāļŠāļ™āļ—āļĩāđˆāđ€āļ›āļīāļ”āđƒāļŦāđ‰āļŠāļēāļ˜āļēāļĢāļ“āļ° āļ„āļļāļ“āļ­āļēāļˆāļžāļīāļˆāļēāļĢāļ“āļēāđƒāļŠāđ‰ submodules āļ”āđ‰āļ§āļĒ

āļ”āļēāļ§āļ™āđŒāđ‚āļŦāļĨāļ”āļ‚āđ‰āļ­āļĄāļđāļĨāļŠāļģāļĢāļ­āļ‡Âķ

Go to /web/database/manager on your on-premise NightPOS instance and click Backup.

āļ­āļīāļ™āđ€āļ—āļ­āļĢāđŒāđ€āļŸāļ‹āđ€āļ§āđ‡āļšāļœāļđāđ‰āļˆāļąāļ”āļāļēāļĢāđāļšāļšāļ•āļīāļ”āļ•āļąāđ‰āļ‡āđ€āļ­āļ‡

āđ€āļĨāļ·āļ­āļ zip (includes filestore) āđ€āļ›āđ‡āļ™ Backup Format

āļāļēāļĢāļ”āļēāļ§āļ™āđŒāđ‚āļŦāļĨāļ”āļ‚āđ‰āļ­āļĄāļđāļĨāļŠāļģāļĢāļ­āļ‡āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļšāļ™āđ€āļ„āļĢāļ·āđˆāļ­āļ‡

Note

āļ­āļąāļ›āđ‚āļŦāļĨāļ”āļ‚āđ‰āļ­āļĄāļđāļĨāļŠāļģāļĢāļ­āļ‡Âķ

In your NightPOS.sh project, navigate to the Backups tab of your Production branch, and click Import Database to upload the backup you previously downloaded.

Importing a database backup on NightPOS.sh

āđ€āļĄāļ·āđˆāļ­āļāļēāļĢāļ™āļģāđ€āļ‚āđ‰āļēāđ€āļŠāļĢāđ‡āļˆāļŠāļĄāļšāļđāļĢāļ“āđŒ āļ„āļļāļ“āļŠāļēāļĄāļēāļĢāļ–āđ€āļ‚āđ‰āļēāļ–āļķāļ‡āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāđ„āļ”āđ‰āđ‚āļ”āļĒāđƒāļŠāđ‰āļ›āļļāđˆāļĄ āđ€āļŠāļ·āđˆāļ­āļĄāļ•āđˆāļ­ āđƒāļ™āđāļ—āđ‡āļš āļ›āļĢāļ°āļ§āļąāļ•āļī āļ‚āļ­āļ‡āļŠāļēāļ‚āļē

Important

āļāļēāļĢāļ™āļģāđ€āļ‚āđ‰āļēāļ‚āđ‰āļ­āļĄāļđāļĨāļŠāļģāļĢāļ­āļ‡ āļˆāļ°āđ€āļ‚āļĩāļĒāļ™āļ—āļąāļšāļ‚āđ‰āļ­āļĄāļđāļĨāļ—āļąāđ‰āļ‡āļŦāļĄāļ” āļ—āļĩāđˆāļĄāļĩāļ­āļĒāļđāđˆāđƒāļ™āļŠāļēāļ‚āļēāļ›āļąāļˆāļˆāļļāļšāļąāļ™ āļžāļīāļˆāļēāļĢāļ“āļēāļ”āļēāļ§āļ™āđŒāđ‚āļŦāļĨāļ”āļ‚āđ‰āļ­āļĄāļđāļĨāļŠāļģāļĢāļ­āļ‡āļ”āđ‰āļ§āļĒāļ•āļ™āđ€āļ­āļ‡āļĨāđˆāļ§āļ‡āļŦāļ™āđ‰āļēāļŦāļēāļāļ„āļļāļ“āļ•āđ‰āļ­āļ‡āļāļēāļĢāđ€āļāđ‡āļšāļĢāļąāļāļĐāļēāļ‚āđ‰āļ­āļĄāļđāļĨāļ—āļĩāđˆāļĄāļĩāļ­āļĒāļđāđˆ

āļ•āļĢāļ§āļˆāļŠāļ­āļšāđ€āļ‹āļīāļĢāđŒāļŸāđ€āļ§āļ­āļĢāđŒāļ­āļĩāđ€āļĄāļĨāļ‚āļēāļ­āļ­āļÂķ

NightPOS.sh provides a default email server. To use it, ensure that no outgoing mail server is enabled in your database by enabling developer mode and navigating to Settings â€Ģ Technical â€Ģ Email: Outgoing Mail Servers

After importing your database, all configured outgoing mail servers are disabled, and the default NightPOS.sh server is used.

Warning

āļžāļ­āļĢāđŒāļ• 25 āļ–āļđāļāļ›āļīāļ”āđāļĨāļ°āļˆāļ°āļĒāļąāļ‡āļ„āļ‡āļ›āļīāļ”āļ­āļĒāļđāđˆ āļŦāļēāļāđ€āļŠāļ·āđˆāļ­āļĄāļ•āđˆāļ­āļāļąāļšāđ€āļ‹āļīāļĢāđŒāļŸāđ€āļ§āļ­āļĢāđŒ SMTP āļ āļēāļĒāļ™āļ­āļ āđƒāļŦāđ‰āđƒāļŠāđ‰āļžāļ­āļĢāđŒāļ• 465 āļŦāļĢāļ·āļ­ 587

āļ•āļĢāļ§āļˆāļŠāļ­āļšāļāļēāļĢāļ”āļģāđ€āļ™āļīāļ™āļāļēāļĢāļ•āļēāļĄāļāļģāļŦāļ™āļ”āļāļēāļĢÂķ

āļāļēāļĢāļ”āļģāđ€āļ™āļīāļ™āļāļēāļĢāļ•āļēāļĄāļāļģāļŦāļ™āļ”āļāļēāļĢāļˆāļ°āļ–āļđāļ āļ›āļīāļ”āđƒāļŠāđ‰āļ‡āļēāļ™āļ•āļēāļĄāļ„āđˆāļēāđ€āļĢāļīāđˆāļĄāļ•āđ‰āļ™ āļŦāļĨāļąāļ‡āļˆāļēāļāļ™āļģāđ€āļ‚āđ‰āļēāļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļ‚āļ­āļ‡āļ„āļļāļ“ āđ€āļžāļ·āđˆāļ­āļ›āđ‰āļ­āļ‡āļāļąāļ™āđ„āļĄāđˆāđƒāļŦāđ‰āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļ—āļĩāđˆāļ™āļģāđ€āļ‚āđ‰āļēāđƒāļŦāļĄāđˆāļ”āļģāđ€āļ™āļīāļ™āļāļēāļĢāļ—āļĩāđˆāļ­āļēāļˆāļāđˆāļ­āļāļ§āļ™āđ„āļ”āđ‰ āđ€āļŠāđˆāļ™:

  • āļŠāđˆāļ‡āļ­āļĩāđ€āļĄāļĨāđƒāļ™āļ„āļīāļ§

  • āđ€āļĢāļĩāļĒāļāđƒāļŠāđ‰āļāļēāļĢāļŠāđˆāļ‡āļˆāļ”āļŦāļĄāļēāļĒāļˆāļģāļ™āļ§āļ™āļĄāļēāļ āļŦāļĢāļ·āļ­

  • āļ‹āļīāļ‡āļ„āđŒāļāļąāļšāļšāļĢāļīāļāļēāļĢāļ‚āļ­āļ‡āļšāļļāļ„āļ„āļĨāļ—āļĩāđˆāļŠāļēāļĄ (āđ€āļŠāđˆāļ™ āļ›āļāļīāļ—āļīāļ™ āļžāļ·āđ‰āļ™āļ—āļĩāđˆāļˆāļąāļ”āđ€āļāđ‡āļšāļ‚āđ‰āļ­āļĄāļđāļĨāļšāļ™āļ„āļĨāļēāļ§āļ”āđŒ)

āļŦāļēāļāļ„āļļāļ“āļ•āđ‰āļ­āļ‡āļāļēāļĢāđƒāļŠāđ‰āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļ—āļĩāđˆāļ™āļģāđ€āļ‚āđ‰āļēāļ™āļĩāđ‰āđƒāļ™āļāļēāļĢāđƒāļŠāđ‰āļ‡āļēāļ™āļˆāļĢāļīāļ‡ āđ€āļ›āļīāļ”āđƒāļŠāđ‰āļ‡āļēāļ™āļ­āļĩāļāļ„āļĢāļąāđ‰āļ‡ āđ€āļ‰āļžāļēāļ°āļāļēāļĢāļ”āļģāđ€āļ™āļīāļ™āļāļēāļĢāļ•āļēāļĄāļāļģāļŦāļ™āļ”āļāļēāļĢāļ—āļĩāđˆāļ„āļļāļ“āļ•āđ‰āļ­āļ‡āļāļēāļĢāđ‚āļ”āļĒāđ€āļ›āļīāļ”āđƒāļŠāđ‰āļ‡āļēāļ™ āđ‚āļŦāļĄāļ”āļ™āļąāļāļžāļąāļ’āļ™āļē āđāļĨāļ°āđ„āļ›āļ—āļĩāđˆ āļāļēāļĢāļ•āļąāđ‰āļ‡āļ„āđˆāļē â€Ģ āļ—āļēāļ‡āđ€āļ—āļ„āļ™āļīāļ„ â€Ģ āļĢāļ°āļšāļšāļ­āļąāļ•āđ‚āļ™āļĄāļąāļ•āļī: āļāļēāļĢāļ”āļģāđ€āļ™āļīāļ™āļāļēāļĢāļ•āļēāļĄāļāļģāļŦāļ™āļ”āļāļēāļĢ

āļĨāļ‡āļ—āļ°āđ€āļšāļĩāļĒāļ™āļāļēāļĢāļŠāļĄāļąāļ„āļĢāļŠāļĄāļēāļŠāļīāļÂķ

āļŦāļĨāļąāļ‡āļˆāļēāļāļ™āļģāđ€āļ‚āđ‰āļēāđāļĨāđ‰āļ§ āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļˆāļ°āļ–āļ·āļ­āļ§āđˆāļēāđ€āļ›āđ‡āļ™ āļ‹āđ‰āļģ āđāļĨāļ°āļˆāļ°āļ–āļđāļāļĒāļāđ€āļĨāļīāļāļāļēāļĢāđ€āļŠāļ·āđˆāļ­āļĄāđ‚āļĒāļ‡āļˆāļēāļāļāļēāļĢāļŠāļĄāļąāļ„āļĢāļŠāļĄāļēāļŠāļīāļāļ­āļ‡āļ„āđŒāļāļĢāļ‚āļ­āļ‡āļ„āļļāļ“

Note

āļ„āļļāļ“āļŠāļēāļĄāļēāļĢāļ–āļĄāļĩāļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāđ€āļ›āļīāļ”āđƒāļŠāđ‰āļ‡āļēāļ™āđ„āļ”āđ‰āđ€āļžāļĩāļĒāļ‡āļŦāļ™āļķāđˆāļ‡āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļ•āđˆāļ­āļāļēāļĢāļŠāļĄāļąāļ„āļĢāļŠāļĄāļēāļŠāļīāļ

āļŦāļēāļāļ„āļļāļ“āļ•āļąāđ‰āļ‡āđƒāļˆāļ—āļĩāđˆāļˆāļ°āļ—āļģāđƒāļŦāđ‰āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļ—āļĩāđˆāļ™āļģāđ€āļ‚āđ‰āļēāļĄāļēāđ€āļ›āđ‡āļ™āļŠāļ āļēāļžāđāļ§āļ”āļĨāđ‰āļ­āļĄāļāļēāļĢāļœāļĨāļīāļ•āļ‚āļ­āļ‡āļ„āļļāļ“:

  1. āļĒāļāđ€āļĨāļīāļāļāļēāļĢāđ€āļŠāļ·āđˆāļ­āļĄāđ‚āļĒāļ‡āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāļāđˆāļ­āļ™āļŦāļ™āđ‰āļēāļ‚āļ­āļ‡āļ„āļļāļ“āļˆāļēāļāļāļēāļĢāļŠāļĄāļąāļ„āļĢāļŠāļĄāļēāļŠāļīāļ

  2. āļĨāļ‡āļ—āļ°āđ€āļšāļĩāļĒāļ™āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨāđƒāļŦāļĄāđˆ

āđ‚āļ›āļĢāļ”āļ”āļđ āđ€āļ­āļāļŠāļēāļĢāļ›āļĢāļ°āļāļ­āļšāļāļēāļĢāļĨāļ‡āļ—āļ°āđ€āļšāļĩāļĒāļ™āļāļēāļ™āļ‚āđ‰āļ­āļĄāļđāļĨ āļŠāļģāļŦāļĢāļąāļšāļ„āļģāđāļ™āļ°āļ™āļģāļ—āļĩāļĨāļ°āļ‚āļąāđ‰āļ™āļ•āļ­āļ™