-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathget-started.html
96 lines (92 loc) · 10 KB
/
get-started.html
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
<!DOCTYPE html>
<html data-bs-theme="light">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
<title>Home - IPNS-Link</title>
<meta name="description" content="The website for everything IPNS-Link related. Get started with using the new internet today.">
<link rel="stylesheet" href="assets/bootstrap/css/bootstrap.min.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lora:400,700,400italic,700italic&display=swap">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Cabin:700&display=swap">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Actor&display=swap">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Aldrich&display=swap">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Alef&display=swap">
<link rel="stylesheet" href="assets/fonts/font-awesome.min.css">
<link rel="stylesheet" href="assets/css/buttons.css">
<link rel="stylesheet" href="assets/css/Codeblock.css">
<link rel="stylesheet" href="assets/css/extra.css">
<link rel="stylesheet" href="assets/css/Highlight-Blue.css">
<link rel="stylesheet" href="assets/css/new-vars.css">
<link rel="stylesheet" href="assets/css/particlejs.css">
</head>
<body id="page-top" data-bs-spy="scroll" data-bs-target="#mainNav" data-bs-offset="77"><!-- particles.js container -->
<div id="particles-js"></div>
<!-- particles.js lib - https://github.com/VincentGarreau/particles.js -->
<script src="https://cdn.jsdelivr.net/particles.js/2.0.0/particles.min.js"></script>
<nav class="navbar navbar-expand-md fixed-top navbar-light" id="mainNav" style="text-align: center;">
<div class="container"><button data-bs-toggle="collapse" class="navbar-toggler navbar-toggler-right" data-bs-target="#navbarResponsive" type="button" aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation" value="Menu"><i class="fa fa-bars"></i></button>
<div class="collapse navbar-collapse" id="navbarResponsive" style="font-family: Alef, sans-serif;"><img src="assets/img/ipfs-logo.png" style="width: 35px;margin-right: 5px;"><a class="navbar-brand" href="index.html">IPNS-Link</a>
<ul class="navbar-nav ms-auto">
<li class="nav-item nav-link"><a class="nav-link" href="./index.html">home</a></li>
</ul>
</div>
</div>
</nav>
<section class="text-center content-section" id="about">
<h1 style="margin-top: -30px;margin-bottom: 40px;">Getting started with IPns-link</h1>
<div class="container" style="background: #2a2c339c;border-radius: 33px;width: 90%;">
<div class="row">
<div class="col-lg-8 mx-auto" style="margin-bottom: 35px;">
<h2 style="font-family: Alef, sans-serif;"><br>quickstart guide for exposer</h2>
<p style="text-align: center;font-family: Alef, sans-serif;">Make sure to check out the <a href="about.html"><strong>about page</strong></a> if your confused what the term "exposer" or "gateway" means.<br><br>In this tutorial, we will look at all the steps required to expose a local http server running locally on port 80 (or any other port).</p>
</div>
<div class="col-lg-8 mx-auto" style="margin-bottom: 40px;">
<h5 style="font-family: Alef, sans-serif;font-size: 23px;">Step 1 - dowload</h5>
<p style="text-align: center;font-family: Alef, sans-serif;">If you have downloaded the IPNS-Link exposer already from the <a href="downloads.html"><strong>download page</strong></a> then you can skip this step. <br></p>
<p style="margin-bottom: 10px;">Run the following command to fetch the exposer code from IPNS-Link's official GitHub.</p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">git clone https://github.com/ipns-link/ipns-link<br>cd ipns-link</p>
</div>
<div class="col-lg-8 mx-auto" style="margin-bottom: 40px;">
<h3 style="font-family: Alef, sans-serif;font-size: 26px;">Step 2 - Install</h3>
<p>If you have <strong>sudo</strong> permissions, run this command:</p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">sudo install ipns-link /usr/local/bin/</p>
<p>If you <strong>do not have sudo</strong> permissions, run the following commands instead:</p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">mkdir -p ~/.bin<br>cp ipns-link ~/.bin<br>export PATH="${PATH}":"${HOME}"/.bin</p>
</div>
<div class="col-lg-8 mx-auto" style="margin-bottom: 40px;">
<h3 style="font-family: Alef, sans-serif;font-size: 26px;">Step 3 - Initialize</h3>
<p>Run the following command and provide a terminal editor of your choice.<br>Provide the corresponding command or absolute path to the executable when prompted.<br></p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">ipns-link init</p>
<p><strong><em>Note: </em></strong><em>You can always change the editor later using <span style="text-decoration: underline;">ipns-link config</span>.</em><br></p>
</div>
<div class="col-lg-8 mx-auto" style="margin-bottom: 40px;">
<h3 style="font-family: Alef, sans-serif;font-size: 26px;">Step 4 - use</h3>
<p>Launch the daemon:</p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">ipns-link daemon</p>
<p>Let's now generate a IPNS-key that will later expose our server. Because the key is hard to remember, we should give it a human-friendly name, e.g. "my-site".<br></p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">ipns-link gen my-site</p>
<p>Now edit the key by using the following command:</p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">ipns-link config my-site</p>
<p>Change local.endpoint to "https://localhost:80" or wherever your http server is running. <br>Then run the following command to expose the server:</p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">ipns-link expose my-site</p>
<p>And your <strong>all done!</strong><br><br><strong>Note: </strong>If you want to use a shortcut you can also run the following command instead of manually changing the config of the key:</p>
<p style="font-family: 'Cutive Mono', monospace;background-color: #434141;color: #34aaae;padding-left: 10px;padding-right: 10px;padding-top: 4px;padding-bottom: 4px;white-space: nowrap;overflow-x: scroll;border-radius: 5px;text-align: left;">ipns-link expose my-site localhost:80</p>
</div>
<div class="col-lg-8 mx-auto">
<h2 style="font-family: Alef, sans-serif;">Misc</h2>
<p style="text-align: center;font-family: Alef, sans-serif;">After you finish this guide, feel free to take a look around at our other resources and leave some <a href="feedback.html"><strong>feedback</strong></a> on the installation process!<br></p>
<div class="btn-group" role="group" style="margin-bottom: 40px;"><a class="btn btn-primary btn-default btn-lg" role="button" style="border-radius: 5px;margin-right: 5px;" href="https://github.com/ipns-link/ipns-link/blob/main/MANUAL.md" target="_blank">Full Exposer guide</a><a class="btn btn-primary btn-default btn-lg" role="button" style="border-radius: 5px;" href="https://github.com/ipns-link/ipns-link-gateway#local-hosting-http" target="_blank">private gateway Guide</a></div>
</div>
</div>
</div>
</section>
<footer>
<div class="container text-center">
<p><br>Copyright © IPNS-Link 2024<br>This website is licensed under <a href="https://choosealicense.com/licenses/mit/"><strong>MIT</strong></a>. All images are royalty-free unless stated otherwise.<br>Contact us: <a href="mailto:[email protected]"><strong>[email protected]</strong></a><br>Source code: <a href="https://github.com/ipns-link"><strong>IPNS-Link GitHub</strong></a><br><br></p>
</div>
</footer>
<script src="assets/bootstrap/js/bootstrap.min.js"></script>
<script src="assets/js/grayscale.js"></script>
<script src="assets/js/particle.js"></script>
</body>
</html>