diff --git a/docs/images/screenshot1.png b/docs/images/screenshot1.png new file mode 100644 index 0000000000..64d75447e0 Binary files /dev/null and b/docs/images/screenshot1.png differ diff --git a/docs/images/screenshot10.png b/docs/images/screenshot10.png new file mode 100644 index 0000000000..9d4dc3adda Binary files /dev/null and b/docs/images/screenshot10.png differ diff --git a/docs/images/screenshot2.png b/docs/images/screenshot2.png new file mode 100644 index 0000000000..cd5c7d6d82 Binary files /dev/null and b/docs/images/screenshot2.png differ diff --git a/docs/images/screenshot3.png b/docs/images/screenshot3.png new file mode 100644 index 0000000000..20649f0a45 Binary files /dev/null and b/docs/images/screenshot3.png differ diff --git a/docs/images/screenshot4.png b/docs/images/screenshot4.png new file mode 100644 index 0000000000..14ea377e3d Binary files /dev/null and b/docs/images/screenshot4.png differ diff --git a/docs/images/screenshot5.png b/docs/images/screenshot5.png new file mode 100644 index 0000000000..8bbcee4be9 Binary files /dev/null and b/docs/images/screenshot5.png differ diff --git a/docs/images/screenshot6.png b/docs/images/screenshot6.png new file mode 100644 index 0000000000..6d349607be Binary files /dev/null and b/docs/images/screenshot6.png differ diff --git a/docs/images/screenshot7.png b/docs/images/screenshot7.png new file mode 100644 index 0000000000..40d211eb4d Binary files /dev/null and b/docs/images/screenshot7.png differ diff --git a/docs/images/screenshot8.png b/docs/images/screenshot8.png new file mode 100644 index 0000000000..eec9634e3d Binary files /dev/null and b/docs/images/screenshot8.png differ diff --git a/docs/images/screenshot9.png b/docs/images/screenshot9.png new file mode 100644 index 0000000000..84228be2ff Binary files /dev/null and b/docs/images/screenshot9.png differ diff --git a/docs/index.md b/docs/index.md index 85875462e4..2d50bb829d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,3 +3,107 @@ ## How to deploy your ComfyUI Workflow to Discord in minutes with SaltAI + +# How to deploy your ComfyUI workflow to Discord with Salt AI + +This guide walks you through deploying your ComfyUI workflow to Discord using Salt AI, enabling you to run and share it in any Discord server. Please note that the Salt AI platform is in early alpha, so you may encounter bugs, and certain operations like loading times could be slower than expected. You can share feedback and get help in our Discord server here: [https://discord.gg/saltai](https://discord.gg/saltai) + +## Initial Setup + +### Logging Into Salt AI + +- First, head to https://getsalt.ai and sign in or create your account. +- After logging in, click on the “Machines” tab in the top navigation bar. + +### Creating Your Machine + +- You’ll notice there are no machines listed initially. To create a new one, click “New Machine”. +- Name your machine (for instance, “Salt Comfy”), then click save. A brief deployment process will follow. + +![Screenshot 1](images/screenshot1.png) + + +![Screenshot 2](images/screenshot2.png) + + +### Accessing ComfyUI + +- Once your machine is set up, return to the “Machines” tab, click the three dots next to your machine, and select “Open Comfy UI”. + +![Screenshot 3](images/screenshot3.png) + + +- It might take a few moments to load. Even if it appears unresponsive, it is still processing. + +## Preparing your workflow in ComfyUI + +### Editing Workflow + +- ComfyUI will load with a default workflow interface. Before deployment to Discord, you need to add or adjust nodes to fit the inputs and outputs desired for your Discord workflow. + +![Screenshot 4](images/screenshot4.png) + + +### Configuring Inputs and Outputs + +- **Inputs**: If you want users of your workflow to be able to modify prompts, you need to incorporate the “Salt Flow Input” node into your workflow. This configuration can also be done locally prior to deployment. +- **Outputs**: Make sure your workflow includes a “Salt Flow Output” node that defines the type of response (e.g., GIF, PNG, MP4, string) your Discord bot will return. +- To add these nodes, right click to Add Node, then select “Salt” from the dropdown —> IO —> Salt Flow Input and Salt Flow Output + +## Deploying Your Workflow + +### Uploading and Deploying + +1. Once you’re ready to deploy, click “Deploy” in the bottom right modal, name your workflow, and use the “Login with Salt” function to give Salt access to your workflow. Then click “Deploy” again. + + ![Screenshot 5](images/screenshot5.png) + + +2. Assign your workflow a unique identifier, confirm the deployment, and then you can view, edit, and copy its JSON for API integration. + + ![Screenshot 6](images/screenshot6.png) + + +3. Once your workflow has been deployed successfully in ComfyUI, click “View here” to see it in the “Workflows” tab of Salt AI. + + ![Screenshot 7](images/screenshot7.png) + + +### Discord Deployment Submission + +- Your workflow requires manual approval by the Salt team before it becomes accessible through the Salt AI Discord bot. Once approved, it’s ready for use. + +## Executing Your Workflow on Discord + +### Adding the Salt AI bot + +1. [**Click here**](https://discord.com/oauth2/authorize?client_id=1113909066587185274&scope=bot&permissions=2147605568) to add the Salt AI bot to any server where you have the required permissions + + ![Screenshot 8](images/screenshot8.png) + + +### Running Workflows + +1. In any Discord with the Salt AI bot added, use the `/workflows` command and hit enter to open up the bot modal. +2. Select “Browse Workflows”, then “New Workflows” —> “Select a recent workflow”. Find your workflow and click “Play” to enter your prompt and run. Based on the type of workflow, you can use text or image to generate your output. + + ![Screenshot 9](images/screenshot9.png) + + ![Screenshot 10](images/screenshot10.png) + + 1. You can also choose “Set default” to make your workflow the default option when others in the server use the /workflows or /play commands. + +### Showcasing your workflows in the Salt AI catalog + +1. To share your workflow with the Salt team and others in the community, first [**join the Salt AI Discord**](https://discord.gg/saltai) and complete onboarding. +2. Then, head to the [**#flow-catalog**](https://discord.gg/FcbmPDf3E7) channel and follow the example template to share your workflow. Be sure to run it using the Salt AI bot in a comment below and pin the comment, so others can easily grab and run it themselves. + + + +## Need Help? + +- This guide is based on the early alpha version of Salt AI. Should you run into any issues or have questions, get in touch with our team via the #support channel in Discord! \ No newline at end of file