Getting Started
- Policygen-rails
- Policygen-js
Customization
- Styling your policies
Configuration
- Configuring your policies
Configuration Reference
This page documents all of the configuration options available in Policygen libraries.
CSS and Styling
css_framework
Type: string
Default: "tailwind"
Which css framework to use?
tailwind_config
Type: object
Default: { "heading_color": "text-gray-800", "body_color": "text-gray-700", "link_color": "text-blue-500" }
Tailwind css configuration
Entity Information
entity_name
Type: string
Default: None
What is the entity name we should use in the policies?
entity_name: "Your entity name" entity_website
Type: string
Default: None
What is the entity website we should use in the policies?
entity_website: "https://www.your-entity-website.com" entity_address
Type: string
Default: None
Do you have a contact address for privacy questions?
entity_address: "1234 Main Street, Anytown, USA" support_email
Type: string
Default: None
Do you have a support email for privacy questions?
support_email: "support@policygen.xyz" privacy_email
Type: string
Default: None
Do you have a privacy email for privacy questions?
privacy_email: "privacy@policygen.xyz" Policy updates
privacy_last_updated
Type: string
Default: None
When was your privacy policy last updated?
privacy_last_updated: "May 31, 2024" tos_last_updated
Type: string
Default: None
When was your terms of service last updated?
tos_last_updated: "May 31, 2024" Policy wide settings
platforms
Type: array
Default: [ "web" ]
Which platforms does your policy apply to?
locations
Type: array
Default: [ "us", "eu", "uk" ]
Which locations does your policy apply to?
entity_location
Type: string
Default: "us"
Where is your entity located?
under_eighteen
Type: boolean
Default: false
Do you allow users under 18?
under_thirteen
Type: boolean
Default: false
Do you allow users under 13?
Terms of Service Specific Settings
purchasable_goods
Type: boolean
Default: false
Do you sell purchasable goods?
subscription
Type: boolean
Default: false
Do you have a subscription?
free_trial
Type: boolean
Default: false
Does your subscription have a free trial?
auto_renew
Type: boolean
Default: false
Does your subscription renew automatically?
refund_policy
Type: string
Default: "none"
What is the refund policy?
user_content
Type: boolean
Default: false
Do you allow users to upload content?
user_content_license
Type: boolean
Default: false
Do you assign a license of user uploaded content?
user_accounts
Type: boolean
Default: false
Do you allow users to create accounts?
governing_law
Type: string
Default: "california"
Governing law clause.
governing_law: "new_york" dispute_resolution
Type: string
Default: "litigation"
Dispute resolution clause.
mediation
Type: boolean
Default: false
Do you want to do informal mediation before arbitration or litigation?
prohibited_uses
Type: array
Default: []
Prohibited uses clause. Add any custom prohibited uses to this array.
prohibited_uses: [
"crawling",
"illegal",
"harmful",
"infringing",
"abusive",
"spam",
"advertising",
"impersonation",
"account_transfer"
] service_sla
Type: boolean
Default: false
Service has an SLA
service_sla_amount
Type: number
Default: 0
Service SLA Amount (out of 100% availability)
service_sla_amount: 99.9 service_sla_timeframe
Type: string
Default: null
Service SLA timeframe.
service_sla_timeframe: "1 month" service_sla_refund
Type: boolean
Default: false
Do you offer a refund if you breach the SLA?
service_sla_custom
Type: string
Default: null
Service SLA custom clause.
If this exists we will use this instead of the amount and timeframe above.
service_sla_custom: "We guarantee 99.9% uptime" liability_limitation
Type: boolean
Default: false
Liability limitation.
liability_limitation_type
Type: string
Default: "amount_paid"
Liability limitation.
liability_limitation_timeframe
Type: string
Default: null
Liability timeframe, set if you have a subscription model.
liability_limitation_timeframe: "6 months" liability_limitation_amount
Type: number
Default: 0
Liability limitation amount.
liability_limitation_amount: 1000 Privacy Specific Settings
personal_information
Type: array
Default: []
What personal information do you collect?
Personal information is any data that can be used to identify an individual.
Add any custom data you collect to this array.
personal_information: [
"name",
"email",
"phone",
"address",
"password",
"ip_address",
"device_id",
"credit_card",
"location_data",
"anonymized_usage_data"
] sensitive_information
Type: array
Default: []
What sensitive information do you collect?
Sensitive information is any data that a user would have a reasonable expectation to remain private.
Add any custom data you collect to this array.
sensitive_information: [
"ssn",
"financial_data",
"health_data",
"biometric_data",
"genetic_data",
"political_affiliation",
"sexual_orientation",
"criminal_history",
"religion"
] third_party_data
Type: array
Default: []
What third-party data do you collect?
Third-party data is any data that you collect from third-party services.
Add any custom data you collect to this array.
third_party_data: [
"advertising_data",
"analytics_data",
"social_media_data",
"purchase_data",
"email_data",
"support_data",
"job_data",
"address_data",
"behavior_data"
] payment_data
Type: boolean
Default: false
Do you collect payment data?
payment_processors
Type: array
Default: []
What payment processors do you use?
Please add the website of any payment processers you use.
payment_processors: [
"https://stripe.com",
"https://paypal.com"
] app_usage_data
Type: boolean
Default: false
Do you store logs or app usage data?
third_party_disclosure
Type: boolean
Default: false
Do you disclose personal information to third parties?
If you use third-party services that collect data, set this to true.
third_party_disclosure_entities
Type: array
Default: []
Third party entities you disclose personal information to.
third_party_disclosure_entities: [
"Google Analytics",
"Facebook Pixel"
] third_party_sharing
Type: boolean
Default: false
Do you sell/share personal information with third parties?
If you sell or share any data with business partners, set this to true.
third_party_sharing_entities
Type: array
Default: []
Third party entities you share personal information with.
third_party_sharing_entities: [
"Google Ads",
"Facebook Ads"
] security_measures
Type: boolean
Default: false
Do you have robust security measures in place?
If you have security measures in place to protect user data, set this to true.
web_tracking
Type: boolean
Default: false
Do you use tracking cookies/web beacons?
third_party_analytics
Type: boolean
Default: false
Do you use third party analytics?
service_requirements
Type: array
Default: []
What do you need to perform to deliver your service?
Accounts = Creating and managing user accounts
Communications = Sending transactional or marketing communications to or between users
Orders = Processing orders and payments
Custom: add your use cases here
service_requirements: [
"accounts",
"communications",
"orders"
] legal_basis
Type: array
Default: []
Under what legal basis do you collect and process data?
legal_basis: [
"advertising",
"marketing",
"analytics",
"security",
"fraud_prevention"
] data_retention_period
Type: string
Default: null
How long do you store user data after account termination?
data_retention_period: "3 months" us_state_privacy_laws
Type: boolean
Default: false
Do you support all US state privacy laws?
privacy_page
Type: string
Default: null
Do you have a privacy management page to link to?
If you don't have a privacy page, users will be told to email you at your privacy_email with deletion and data requests.
privacy_page: "https://www.your-entity-website.com/privacy" dpo
Type: boolean
Default: false
Do you have a Data Protection Officer (DPO)?
dpo_name
Type: string
Default: null
What is the DPO's name?
dpo_name: "Ed Po" dpo_email
Type: string
Default: null
What is the DPO's email?
dpo_phone
Type: string
Default: null
What is the DPO's phone number?