Skip to content

Commit 40c93f6

Browse files
authored
Merge pull request #314 from ipfs/docs/improve-default-landing-page
docs: improve default landing page for third-party deployments
2 parents 633fa6c + a6c7c75 commit 40c93f6

File tree

1 file changed

+79
-35
lines changed

1 file changed

+79
-35
lines changed

static/index.html

Lines changed: 79 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,54 +3,98 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>Welcome to Rainbow IPFS Gateway</title>
6+
<meta name="robots" content="noindex">
7+
<meta name="description" content="Default landing page for Rainbow, an IPFS HTTP Gateway implementation.">
8+
<meta property="og:title" content="Welcome to Rainbow IPFS Gateway!">
9+
<meta property="og:description" content="Default landing page for Rainbow, an IPFS HTTP Gateway implementation.">
10+
<meta property="og:type" content="website">
11+
<title>Welcome to Rainbow IPFS Gateway!</title>
712
<style>
13+
html { color-scheme: light dark; }
814
body {
15+
max-width: 40em;
16+
margin: 2em auto;
17+
padding: 0 1em;
18+
font-family: system-ui, -apple-system, sans-serif;
19+
line-height: 1.6;
920
background: linear-gradient(90deg, red, orange, green, blue, indigo, violet);
10-
font-family: Arial, sans-serif;
11-
text-align: center;
12-
color: white;
1321
}
14-
.container {
15-
max-width: 800px;
16-
margin: 0 auto;
17-
padding: 20px;
22+
#body {
23+
background: white;
24+
padding: 10px 20px 10px 20px;
25+
border-radius: 20px 20px 20px 20px;
1826
}
1927
h1 {
20-
font-size: 36px;
28+
border-bottom: 2px solid;
29+
padding-bottom: 0.3em;
2130
}
22-
h2 {
23-
font-size: 36px;
24-
margin-bottom: 50px;
25-
}
26-
p {
27-
font-size: 18px;
28-
margin: 20px 0 40px 0;
31+
.note {
32+
background: rgba(128, 128, 128, 0.1);
33+
border-left: 4px solid rgba(128, 128, 128, 0.5);
34+
padding: 0.5em 1em;
35+
margin: 1.5em 0;
2936
}
30-
a {
31-
text-decoration: none;
32-
color: #ffffff;
33-
border: 1px solid #ffffff;
34-
padding: 10px 20px;
35-
border-radius: 5px;
36-
font-size: 16px;
37-
margin: 10px;
38-
transition: background-color 0.3s, border-color 0.3s;
37+
a { color: #0969da; }
38+
@media (prefers-color-scheme: dark) {
39+
a { color: #58a6ff; }
3940
}
40-
a:hover {
41-
background-color: rgba(255, 255, 255, 0.2);
42-
border-color: rgba(255, 255, 255, 0.8);
41+
ul { padding-left: 1.5em; }
42+
li { margin: 0.3em 0; }
43+
.rainbow {
44+
background: linear-gradient(90deg, #ff0000, #ff8000, #ffff00, #00ff00, #0080ff, #8000ff, #ff0000);
45+
background-size: 200% 100%;
46+
-webkit-background-clip: text;
47+
background-clip: text;
48+
color: transparent;
49+
animation: rainbow 3s linear infinite;
50+
}
51+
@keyframes rainbow {
52+
0% { background-position: 0% 50%; }
53+
100% { background-position: 200% 50%; }
4354
}
4455
</style>
4556
</head>
4657
<body>
47-
<div class="container">
48-
<h1>Welcome to Rainbow</h1>
49-
<h2>The high performant IPFS Gateway</h2>
50-
<p>Your gateway to a colorful world of decentralized content.</p>
51-
<a href="https://ipfs.tech" target="_blank">Learn about IPFS</a>
52-
<a href="https://github.com/ipfs/rainbow" target="_blank">GitHub Repository</a>
53-
<a href="mailto:abuse@ipfs.io" target="_blank">Send abuse reports</a>
58+
<div id="body">
59+
<h1>Welcome to <span class="rainbow">Rainbow</span>!</h1>
60+
61+
<p>If you see this page, the <a href="https://github.com/ipfs/rainbow" target="_blank" rel="noopener noreferrer">Rainbow IPFS gateway software</a> has been successfully installed and working. Further configuration is required.</p>
62+
63+
<p>For configuration options, please refer to the <a href="https://github.com/ipfs/rainbow/blob/main/docs/environment-variables.md" target="_blank" rel="noopener noreferrer">documentation</a>.</p>
64+
65+
<div class="note">
66+
<strong>Note to gateway operators:</strong> This is the default landing page.
67+
Replace it with content relevant to your deployment.
5468
</div>
69+
70+
<h2>Resources</h2>
71+
<ul>
72+
<li><a href="https://github.com/ipfs/rainbow" target="_blank" rel="noopener noreferrer">Rainbow on GitHub</a></li>
73+
<li><a href="https://ipfs.tech" target="_blank" rel="noopener noreferrer">About IPFS</a></li>
74+
<li><a href="https://docs.ipfs.tech/concepts/glossary/#gateway" target="_blank" rel="noopener noreferrer">IPFS Gateway Documentation</a></li>
75+
<li><a href="https://specs.ipfs.tech/http-gateways/" target="_blank" rel="noopener noreferrer">IPFS HTTP Gateway Specifications</a></li>
76+
</ul>
77+
78+
<h2>Abuse Reports</h2>
79+
<p id="abuse-info">
80+
This gateway is operated by a third party. To report abuse, contact the operator or owner of
81+
<span id="gateway-host"></span>.
82+
</p>
83+
<script>
84+
(function() {
85+
var host = document.getElementById('gateway-host');
86+
var hostname = window.location.hostname;
87+
var link = document.createElement('a');
88+
link.href = 'https://whois.domaintools.com/' + hostname;
89+
link.target = '_blank';
90+
link.rel = 'noopener noreferrer';
91+
link.textContent = hostname;
92+
host.appendChild(link);
93+
})();
94+
</script>
95+
<noscript>
96+
<p>To report abuse, look up the domain owner using a WHOIS service.</p>
97+
</noscript>
98+
</div>
5599
</body>
56100
</html>

0 commit comments

Comments
 (0)