forked from gpt4free/g4f.dev
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocker.html
More file actions
643 lines (570 loc) · 23.7 KB
/
Copy pathdocker.html
File metadata and controls
643 lines (570 loc) · 23.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
<!DOCTYPE html>
<html lang="en" data-color-mode="auto" data-light-theme="light" data-dark-theme="dark">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>G4F - Docker Setup</title>
<meta name="description" content="GPT4Free documentation for G4F - Docker Setup. Complete guides, examples, and API reference for free AI endpoints, code generation, and AI model integration." />
<meta name="keywords" content="GPT4Free, G4F, AI documentation, free AI API, OpenAI alternative, JavaScript AI client, Python AI library, AI integration, code generation, G4F - Docker Setup" />
<meta name="author" content="GPT4Free Team" />
<!-- Open Graph -->
<meta property="og:type" content="article" />
<meta property="og:title" content="G4F - Docker Setup | GPT4Free Documentation" />
<meta property="og:description" content="GPT4Free documentation for G4F - Docker Setup. Free AI endpoints, examples, and comprehensive guides." />
<meta property="og:url" content="https://g4f.dev/docs/docker.html" />
<meta property="og:site_name" content="GPT4Free Documentation" />
<meta property="og:image" content="https://g4f.dev/dist/img/g4f.svg" />
<!-- Twitter Card -->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="G4F - Docker Setup | GPT4Free Documentation" />
<meta name="twitter:description" content="Free AI endpoints and comprehensive documentation for G4F - Docker Setup." />
<meta name="twitter:image" content="https://g4f.dev/dist/img/g4f.svg" />
<!-- Canonical -->
<link rel="canonical" href="https://g4f.dev/docs/docker.html" />
<link rel="apple-touch-icon" sizes="180x180" href="/dist/img/g4f.svg" />
<link rel="icon" type="image/png" sizes="32x32" href="/dist/img/g4f-32x32.png" />
<link rel="icon" type="image/png" sizes="16x16" href="/dist/img/g4f-16x16.png" />
<link rel="manifest" href="/dist/img/site.webmanifest" />
<!-- GitHub Primer CSS & styles -->
<link crossorigin="anonymous" media="all" rel="stylesheet" href="https://github.githubassets.com/assets/light-74231a1f3bbb.css" />
<link crossorigin="anonymous" media="all" rel="stylesheet" href="https://github.githubassets.com/assets/dark-8a995f0bacd4.css" />
<link crossorigin="anonymous" media="all" rel="stylesheet" href="https://github.githubassets.com/assets/primer-primitives-225433424a87.css" />
<link crossorigin="anonymous" media="all" rel="stylesheet" href="https://github.githubassets.com/assets/primer-b8b91660c29d.css" />
<link crossorigin="anonymous" media="all" rel="stylesheet" href="https://github.githubassets.com/assets/global-205098e9fedd.css" />
<link crossorigin="anonymous" media="all" rel="stylesheet" href="https://github.githubassets.com/assets/code-177d21388df8.css" />
<style>
:root {
--accent: #8b3dff;
--background: #16101b;
--text-primary: #ddd;
--text-secondary: #9b7dff;
--card-bg: #1e152e;
--border-color: #333;
--hover-color: #a67eff;
}
body {
margin: 0;
padding: 0;
background: var(--background);
color: var(--text-primary);
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
line-height: 1.6;
min-height: 100vh;
}
.container {
display: flex;
max-width: 100%;
margin: 0;
padding: 2rem;
gap: 3rem;
min-height: calc(100vh - 4rem);
}
/* Enhanced main content styling */
main {
flex: 1;
background: var(--card-bg);
border-radius: 12px;
padding: 2.5rem;
box-shadow: 0 8px 30px rgba(0,0,0,0.7);
overflow-wrap: break-word;
position: relative;
}
/* Typography improvements */
.markdown-body h1 {
font-size: 2.8rem;
margin-bottom: 1rem;
font-weight: 700;
color: var(--text-primary);
border-bottom: 3px solid var(--accent);
padding-bottom: 0.5rem;
}
.markdown-body h2 {
margin-top: 3rem;
margin-bottom: 1rem;
border-bottom: 2px solid var(--accent);
padding-bottom: 0.25rem;
color: var(--text-primary);
}
.markdown-body h3 {
margin-top: 2rem;
margin-bottom: 0.8rem;
color: var(--text-primary);
}
.markdown-body p {
margin-bottom: 1.2rem;
color: var(--text-primary);
}
/* Enhanced link styling */
.markdown-body a {
color: var(--accent);
text-decoration: none;
transition: all 0.3s ease;
font-weight: 500;
}
.markdown-body a:hover,
.markdown-body a:focus {
color: var(--hover-color);
outline: none;
text-decoration: underline;
text-shadow: 0 0 8px rgba(139, 61, 255, 0.3);
}
/* Enhanced code block styling */
.markdown-body pre {
border-radius: 12px;
padding: 1.5rem !important;
font-size: 0.95rem !important;
overflow-x: auto;
max-height: 500px;
box-shadow: inset 0 0 12px rgba(0,0,0,0.6), 0 4px 20px rgba(0,0,0,0.4);
color: #fff;
border: 1px solid #3d2a5c;
position: relative;
}
.markdown-body code {
font-family: 'SF Mono', 'Cascadia Code', 'Roboto Mono', Consolas, Liberation Mono, Menlo, monospace;
background: rgba(139, 61, 255, 0.1);
padding: 0.2em 0.4em;
border-radius: 4px;
color: #e6ccff;
font-size: 0.9em;
}
.markdown-body pre code {
background: transparent;
padding: 0;
color: var(--fgColor-default, var(--color-fg-default))
}
/* Table styling */
.markdown-body table {
border-collapse: collapse;
width: 100%;
margin: 2rem 0;
border-radius: 8px;
overflow: hidden;
box-shadow: 0 4px 20px rgba(0,0,0,0.3);
}
.markdown-body table th,
.markdown-body table td {
padding: 1rem;
text-align: left;
border: 1px solid var(--border-color);
}
.markdown-body table th {
background: var(--accent);
color: white;
font-weight: 600;
}
.markdown-body table tr:nth-child(even) {
background: rgba(139, 61, 255, 0.05);
}
.markdown-body table tr {
background-color: transparent;
}
/* List styling */
.markdown-body ul,
.markdown-body ol {
margin-bottom: 1.5rem;
padding-left: 2rem;
}
.markdown-body li {
margin-bottom: 0.5rem;
color: var(--text-primary);
}
/* Blockquote styling */
.markdown-body blockquote {
border-left: 4px solid var(--accent);
background: rgba(139, 61, 255, 0.1);
margin: 2rem 0;
padding: 1rem 1.5rem;
border-radius: 0 8px 8px 0;
}
/* HR styling */
.markdown-body hr {
border: none;
border-top: 2px solid var(--accent);
margin: 3rem 0;
opacity: 0.6;
}
/* Sticky table of contents */
nav#toc {
flex: 0 0 280px;
position: sticky;
top: 2rem;
background: var(--card-bg);
padding: 1.5rem;
border-radius: 12px;
box-shadow: 0 8px 30px rgba(0,0,0,0.7);
max-height: calc(100vh - 4rem);
overflow-y: auto;
font-size: 0.9rem;
line-height: 1.5;
border: 1px solid rgba(139, 61, 255, 0.2);
}
nav#toc h2 {
font-size: 1.4rem;
margin: 0 0 1.5rem 0;
border-bottom: 2px solid var(--accent);
padding-bottom: 0.5rem;
color: var(--text-primary);
}
nav#toc ul {
list-style: none;
padding-left: 0;
margin: 0;
}
nav#toc li {
margin-bottom: 0.8rem;
}
nav#toc a {
color: var(--text-secondary);
text-decoration: none;
display: block;
padding: 0.3rem 0.5rem;
border-radius: 6px;
transition: all 0.3s ease;
}
nav#toc a:hover,
nav#toc a:focus {
background: rgba(139, 61, 255, 0.1);
color: var(--hover-color);
text-decoration: none;
transform: translateX(4px);
}
/* Responsive design */
@media (max-width: 1024px) {
.container {
flex-direction: column;
padding: 1rem;
gap: 2rem;
}
nav#toc {
position: relative;
max-height: none;
order: -1;
flex: none;
}
.markdown-body h1 {
font-size: 2.2rem;
}
}
@media (max-width: 768px) {
.container {
padding: 0.5rem;
}
main {
padding: 1.5rem;
}
.markdown-body h1 {
font-size: 1.8rem;
}
.markdown-body pre {
padding: 1rem !important;
font-size: 0.85rem !important;
}
}
/* Accessibility improvements */
@media (prefers-reduced-motion: reduce) {
* {
animation-duration: 0.01ms !important;
animation-iteration-count: 1 !important;
transition-duration: 0.01ms !important;
}
}
/* Focus indicators */
*:focus {
outline: 2px solid var(--accent);
outline-offset: 2px;
}
/* Print styles */
@media print {
.container {
display: block;
}
nav#toc {
display: none;
}
main {
box-shadow: none;
background: white;
color: black;
}
}
/* Loading animation for syntax highlighting */
.highlight-loading {
position: relative;
opacity: 0.7;
}
.highlight-loading::after {
content: 'Loading syntax highlighting...';
position: absolute;
top: 1rem;
right: 1rem;
font-size: 0.8rem;
color: rgba(255, 255, 255, 0.6);
}
/* Translate Button Style */
#translate-toggle {
display: block;
background: var(--accent);
color: #fff;
text-align: center;
padding: 0.5rem;
border-radius: 6px;
margin-bottom: 1rem;
cursor: pointer;
font-size: 0.9rem;
border: none;
}
#google_translate_element {
margin-bottom: 1rem;
}
</style>
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "TechArticle",
"headline": "G4F - Docker Setup",
"description": "GPT4Free documentation for G4F - Docker Setup. Complete guides, examples, and API reference for free AI endpoints.",
"author": {
"@type": "Organization",
"@id": "https://g4f.dev/#organization",
"name": "GPT4Free",
"url": "https://g4f.dev",
"logo": {
"@type": "ImageObject",
"url": "https://g4f.dev/dist/img/g4f.svg"
}
},
"publisher": {
"@type": "Organization",
"@id": "https://g4f.dev/#organization"
},
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "https://g4f.dev/docs/docker.html"
},
"datePublished": "2024-01-01T00:00:00Z",
"dateModified": "2024-01-01T00:00:00Z",
"inLanguage": "en",
"isAccessibleForFree": true,
"keywords": "GPT4Free, AI documentation, free AI API, code generation",
"articleSection": "Documentation"
}
</script>
</head>
<body>
<div class="container">
<nav id="toc" aria-label="Table of contents" role="navigation">
<!-- Translation Button -->
<button id="translate-toggle">🌐 Translate Page</button>
<div id="google_translate_element" style="display:none;"></div>
<h2>Contents</h2>
<ul id="toc-list">
<!-- Table of contents will be generated here -->
</ul>
<hr style="margin: 1.5rem 0; opacity: 0.3;">
<ul>
<li><a href="/docs/" aria-label="Return to documentation home">📚 Documentation Hub</a></li>
<li><a href="/" aria-label="Return to main site">🏠 G4F Home</a></li>
</ul>
</nav>
<main role="main" class="markdown-body entry-content" itemprop="text" itemscope itemtype="https://schema.org/TechArticle">
<h2>G4F - Docker Setup</h2>
<h2>Table of Contents</h2>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation-and-setup">Installation and Setup</a></li>
<li><a href="#testing-the-api">Testing the API</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
<li><a href="#stopping-the-service">Stopping the Service</a></li>
</ul>
<h2>Prerequisites</h2>
<p><strong>Before you begin, ensure you have the following installed on your system:</strong></p>
<ul>
<li><a href="https://docs.docker.com/get-docker/" rel="nofollow">Docker</a></li>
<li><a href="https://docs.docker.com/compose/install/" rel="nofollow">Docker Compose</a></li>
<li>Python 3.7 or higher</li>
<li>pip (Python package manager)</li>
</ul>
<p><strong>Note:</strong> If you encounter issues with Docker, you can run the project directly using Python.</p>
<h2>Installation and Setup</h2>
<h3>Docker Method (Recommended)</h3>
<ol>
<li>
<p><strong>Clone the Repository</strong></p>
<div class="highlight highlight-source-shell"><pre class="notranslate">git clone https://github.com/xtekky/gpt4free.git
<span class="pl-c1">cd</span> gpt4free</pre></div>
</li>
<li>
<p><strong>Build and Run with Docker Compose</strong></p>
<p>Pull the latest image and run a container with Google Chrome support:</p>
<div class="highlight highlight-source-shell"><pre class="notranslate"> docker pull hlohaus789/g4f
docker-compose up -d</pre></div>
<p>Or run the small docker images without Google Chrome:</p>
<div class="highlight highlight-source-shell"><pre class="notranslate"> docker-compose -f docker-compose-slim.yml up -d</pre></div>
</li>
<li>
<p><strong>Access the API or the GUI</strong></p>
<p>The api server will be accessible at <code class="notranslate">http://localhost:1337</code></p>
<p>And the gui at this url: <code class="notranslate">http://localhost:8080</code></p>
</li>
</ol>
<h3>Non-Docker Method</h3>
<p>If you encounter issues with Docker, you can run the project directly using Python:</p>
<ol>
<li>
<p><strong>Clone the Repository</strong></p>
<div class="highlight highlight-source-shell"><pre class="notranslate">git clone https://github.com/xtekky/gpt4free.git
<span class="pl-c1">cd</span> gpt4free</pre></div>
</li>
<li>
<p><strong>Install Dependencies</strong></p>
<div class="highlight highlight-source-shell"><pre class="notranslate">pip install -r requirements.txt</pre></div>
</li>
<li>
<p><strong>Run the Server</strong></p>
<div class="highlight highlight-source-shell"><pre class="notranslate">python -m g4f.api.run</pre></div>
</li>
<li>
<p><strong>Access the API or the GUI</strong></p>
<p>The api server will be accessible at <code class="notranslate">http://localhost:1337</code></p>
<p>And the gui at this url: <code class="notranslate">http://localhost:8080</code></p>
</li>
</ol>
<h2>Testing the API</h2>
<p><strong>You can test the API using curl or by creating a simple Python script:</strong></p>
<h3>Using curl</h3>
<div class="highlight highlight-source-shell"><pre class="notranslate">curl -X POST -H <span class="pl-s"><span class="pl-pds">"</span>Content-Type: application/json<span class="pl-pds">"</span></span> -d <span class="pl-s"><span class="pl-pds">'</span>{"prompt": "What is the capital of France?"}<span class="pl-pds">'</span></span> http://localhost:1337/chat/completions</pre></div>
<h3>Using Python</h3>
<p><strong>Create a file named <code class="notranslate">test_g4f.py</code> with the following content:</strong></p>
<div class="highlight highlight-source-python"><pre class="notranslate"><span class="pl-k">import</span> <span class="pl-s1">requests</span>
<span class="pl-s1">url</span> <span class="pl-c1">=</span> <span class="pl-s">"http://localhost:1337/v1/chat/completions"</span>
<span class="pl-s1">body</span> <span class="pl-c1">=</span> {
<span class="pl-s">"model"</span>: <span class="pl-s">"gpt-4o-mini"</span>,
<span class="pl-s">"stream"</span>: <span class="pl-c1">False</span>,
<span class="pl-s">"messages"</span>: [
{<span class="pl-s">"role"</span>: <span class="pl-s">"assistant"</span>, <span class="pl-s">"content"</span>: <span class="pl-s">"What can you do?"</span>}
]
}
<span class="pl-s1">json_response</span> <span class="pl-c1">=</span> <span class="pl-s1">requests</span>.<span class="pl-c1">post</span>(<span class="pl-s1">url</span>, <span class="pl-s1">json</span><span class="pl-c1">=</span><span class="pl-s1">body</span>).<span class="pl-c1">json</span>().<span class="pl-c1">get</span>(<span class="pl-s">'choices'</span>, [])
<span class="pl-k">for</span> <span class="pl-s1">choice</span> <span class="pl-c1">in</span> <span class="pl-s1">json_response</span>:
<span class="pl-en">print</span>(<span class="pl-s1">choice</span>.<span class="pl-c1">get</span>(<span class="pl-s">'message'</span>, {}).<span class="pl-c1">get</span>(<span class="pl-s">'content'</span>, <span class="pl-s">''</span>))</pre></div>
<p><strong>Run the script:</strong></p>
<div class="highlight highlight-source-shell"><pre class="notranslate">python test_g4f.py</pre></div>
<h2>Troubleshooting</h2>
<ul>
<li>If you encounter issues with Docker, try running the project directly using Python as described in the Non-Docker Method.</li>
<li>Ensure that you have the necessary permissions to run Docker commands. You might need to use <code class="notranslate">sudo</code> or add your user to the <code class="notranslate">docker</code> group.</li>
<li>If the server doesn't start, check the logs for any error messages and ensure all dependencies are correctly installed.<br>
interference<br>
<strong><em>For more detailed information on API endpoints and usage, refer to the <a href="/docs/interference-api.html">G4F API documentation</a>.</em></strong></li>
</ul>
<h2>Stopping the Service</h2>
<h3>Docker Method</h3>
<p><strong>To stop the Docker containers, use the following command:</strong></p>
<div class="highlight highlight-source-shell"><pre class="notranslate">docker-compose down</pre></div>
<h3>Non-Docker Method</h3>
<p>If you're running the server directly with Python, you can stop it by pressing Ctrl+C in the terminal where it's running.</p>
<hr>
<p><a href="/docs/">Return to Documentation</a></p>
</main>
</div>
<script>
// Toggle Translation Widget
document.getElementById("translate-toggle").addEventListener("click", function() {
const el = document.getElementById("google_translate_element");
el.style.display = (el.style.display === "none") ? "block" : "none";
});
function googleTranslateElementInit() {
new google.translate.TranslateElement({
pageLanguage: 'en',
layout: google.translate.TranslateElement.InlineLayout.SIMPLE
}, 'google_translate_element');
}
</script>
<script src="https://translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>
<script>
// Enhanced syntax highlighting with error handling
document.addEventListener('DOMContentLoaded', function() {
try {
// Generate table of contents
generateTableOfContents();
} catch (error) {
console.error('Error generating table of contents:', error);
}
});
function generateTableOfContents() {
const headings = document.querySelectorAll('main h2, main h3');
const tocList = document.getElementById('toc-list');
if (!tocList || headings.length === 0) return;
tocList.innerHTML = '';
headings.forEach(function(heading, index) {
const id = heading.id || `heading-${index}`;
if (!heading.id) {
heading.id = id;
}
const li = document.createElement('li');
const a = document.createElement('a');
a.href = `#${id}`;
a.textContent = heading.textContent;
a.setAttribute('aria-label', `Jump to ${heading.textContent}`);
if (heading.tagName === 'H3') {
li.style.marginLeft = '1rem';
li.style.fontSize = '0.9em';
}
li.appendChild(a);
tocList.appendChild(li);
});
}
// Smooth scrolling for anchor links
document.addEventListener('click', function(e) {
if (e.target.tagName === 'A' && e.target.getAttribute('href').startsWith('#')) {
e.preventDefault();
const target = document.querySelector(e.target.getAttribute('href'));
if (target) {
target.scrollIntoView({
behavior: 'smooth',
block: 'start'
});
}
}
});
// Add copy button to code blocks
document.querySelectorAll('pre code, .highlight pre').forEach(function(block) {
const button = document.createElement('button');
button.textContent = 'Copy';
button.className = 'copy-button';
button.style.cssText = `
position: absolute;
top: 0.5rem;
right: 0.5rem;
background: rgba(139, 61, 255, 0.8);
color: white;
border: none;
padding: 0.25rem 0.5rem;
border-radius: 4px;
cursor: pointer;
font-size: 0.8rem;
opacity: 0;
transition: opacity 0.3s ease;
`;
const pre = block.parentElement;
pre.style.position = 'relative';
pre.appendChild(button);
pre.addEventListener('mouseenter', function() {
button.style.opacity = '1';
});
pre.addEventListener('mouseleave', function() {
button.style.opacity = '0';
});
button.addEventListener('click', function() {
navigator.clipboard.writeText(block.textContent).then(function() {
button.textContent = 'Copied!';
setTimeout(function() {
button.textContent = 'Copy';
}, 2000);
});
});
});
</script>
</body>
</html>