@@ -81,7 +81,7 @@ Always specify a port, as Caddy Proxy cannot automatically determine the service
81
81
82
82
4. Test your template
83
83
84
- Use the `Docker Compose` deployment option in Coolify to test your template. This process mimics the one-click service deployment.
84
+ Use the `Docker Compose Empty ` deployment option in Coolify to test your template. This process mimics the one-click service deployment.
85
85
86
86
5. Submit a Pull Request
87
87
@@ -91,11 +91,68 @@ Always specify a port, as Caddy Proxy cannot automatically determine the service
91
91
- Add your new `<service>.yaml` compose file under `/templates/compose`
92
92
- Include the logo file in the `svgs` folder
93
93
94
- :: : info
95
- Coolify uses a [parsed version](https://github.com/coollabsio/coolify/blob/main/templates/service-templates.json) of the templates for deployment.
96
- :: :
94
+ :: : info
95
+ Coolify uses a [parsed version](https://github.com/coollabsio/coolify/blob/main/templates/service-templates.json) of the templates for deployment.
96
+ :: :
97
+
98
+ # # Adding a new service template to the Coolify Documentation
99
+
100
+ Once your service template is merged into Coolify, add documentation to this repository :
101
+
102
+ 1. Add service logo
103
+
104
+ - Add the logo under `/docs/public/images/services/`
105
+
106
+ 2. Create documentation file
107
+
108
+ Create `/docs/services/<service-name>.md` with frontmatter :
109
+
110
+ ` ` ` yaml
111
+ ---
112
+ title: "Service Name"
113
+ description: "Here you can find the documentation for hosting Service Name with Coolify."
114
+ ---
115
+ ` ` `
116
+
117
+ 3. Write documentation
118
+
119
+ Start writing your documentation under the frontmatter. Use the following template as a starting point :
120
+
121
+ ` ` ` markdown
122
+ # [Service Name]
123
+
124
+ <ZoomableImage src="/docs/images/services/service.svg" />
125
+
126
+ ## What is [Service Name]?
127
+
128
+ Brief description and use cases.
129
+
130
+ ## Links
131
+
132
+ - [Official website ↗](https://example.com?utm_source=coolify)
133
+ - [GitHub ↗](https://github.com/example/repo?utm_source=coolify)
134
+ ` ` `
135
+
136
+ 4. Add Service to the Services Overview
137
+
138
+ - Add the new service to the service list under `docs\.vitepress\theme\components\Services\List.vue` following the existing format :
139
+
140
+ ` ` ` js
141
+ {
142
+ name: 'Service Name',
143
+ slug: 'service-name', # Match the filename of your documentation file
144
+ icon: '/public/images/services/service.svg', # Path to your logo
145
+ description: 'Brief description of the service.',
146
+ category: 'Analytics' # Choose an appropriate category
147
+ },
148
+ ` ` `
149
+
150
+ 5. Submit Pull Request
151
+
152
+ - Target the `next` branch
153
+ - Test documentation renders correctly with `bun run dev`
97
154
98
- # # Request a new service
155
+ # Request a new service
99
156
100
157
If there's a service template you'd like to see in Coolify :
101
158
0 commit comments