Overview#

This document serves as a comprehensive guide for users looking to share their applications and services either publicly on the internet or privately within their fleet. It is tailored for panel users who have at least one scope running an app and want to create a public URL or enable internal communication between services.

What is Sharing?#

Sharing refers to the process of making applications and services accessible to other users or systems. This can be done either publicly, allowing anyone on the internet to access the service, or privately, restricting access to specific internal services.

Understanding Public Domains#

Public domains are web addresses that allow external users to access your applications. When you share a service publicly, it becomes available to anyone with the URL.

Examples of Public Domain Content#

• Websites hosting open-source software
• Educational resources available for free
• Public APIs that provide data to developers

Legal Implications#

When sharing content, it is crucial to understand the legal implications, including copyright laws and the responsibilities of the content owner. Ensure compliance with relevant regulations to avoid legal issues.

Best Practices for Sharing#

1. Understand the scope of sharing: Know whether your service should be public or internal.
2. Use proper commands: For public sharing, use:

   gritivactl domain add app.example.com --scope my-app --port 8080

   For internal sharing, use:

   gritivactl service create db --scope my-db --port 5432
   gritivactl share allow --service my-db:db --to my-app

3. Monitor access: Keep track of who accesses your services and how they are used.

User Scenarios#

Scenario 1: Public Domain Sharing#

• User wants to make their application accessible to the public.
• They execute the command to add a domain, which provisions necessary resources.

Scenario 2: Internal Sharing#

• User wants to allow an internal application to communicate with a database.
• They use the sharing commands to enable access between services.

Conclusion#

Sharing applications and services effectively requires understanding the differences between public and internal sharing, as well as the legal implications and best practices involved. By following the guidelines outlined in this document, users can ensure secure and efficient sharing.