General

Here are some system configurations, you can configure some system parameters here, such as the port to listen on, the address to listen on, logs, etc.

Configuration

The configuration includes the following parameters:

• mode: The mode of the service. You can set it to local or remote. If you deploy this service on a remote server, it is recommended to set mode to remote. Optional
• port: The port to listen on. Optional
• host: The address to listen on. Optional
• debug: If there are some problems, you can set debug to true. Optional
• logger: If you want to use Fastify Logger, you can set logger to true. Optional
• watch: If you want the service to listen to the changes of the configuration file and update automatically, you can set watch to true. Optional
• Https: The configuration for HTTPS. Optional
  • enabled: Enable HTTPS. Optional
  • host: The host to the certificate file (in auto generate mode). Optional
  • key: The path to the key file. Optional
  • cert: The path to the certificate file. Optional
  • ca: The path to the CA file. Optional
• Permissions: The configuration for permissions. Optional ^v0.7.0-beta.1
  • Full: The full permissions. Optional
  • Sync: The sync permissions. Optional
  • Ai: The AI permissions. Optional
  • Translation: The translation permissions. Optional

HTTPS Note

When Https.key, Https.cert, Https.ca are configured, a custom certificate will be used, and the configuration of Https.host will be ignored, and the certificate will not be generated automatically.

Please refer to the Generate Self-signed Certificate to use with Raycast Unblock - Intercept Raycast guide for more information.

Permissions Note

You need to fill in the user's email inside. For example:

[General.Permissions]
Full = [ 'ray@pro.com' ]

The above example means that the user with the email ray@pro.com has full permission to use.

1. Full is the full permission to use, if you write in Full, you don't need to write anywhere else, and the rest is up to you to understand.
2. The Raycast Client instance must successfully request /me to record the User
3. Currently, due to design reasons, the User record will be lost every time Ray Pro restarts

Example

[General]
# mode = "local"
# port = 3000
# host = "0.0.0.0"
# debug = false
# logger = false
# watch = false

[General.Https]
# enabled = true
# host = '192.168.3.2'
# key = "path
# cert = "path"
# ca = "path"

# [General.Permissions]
# Full = []
# Sync = []
# Ai = []
# Translation = []