diff --git a/README.md b/README.md
index 1ebca02b604065f14b0f326547ebeb8b36b7d82a..829fadc4d3466ca4530bec53aa1048246f6d07d9 100644
--- a/README.md
+++ b/README.md
@@ -65,7 +65,7 @@ The data provided (per each requested URL handled by the ServiceWorker) is:
- `url` – the URL of the request
- `serviceWorker` – the commit SHA of the ServiceWorker that handled the request
- `fetchError` – `null` if the request completed successfully via regular HTTPS; otherwise the error message
- - `method` – the method by which the request was completed: "`fetch`" is regular HTTPS `fetch()`, `gun+ipfs` means Gun and IPFS were used, etc.
+ - `method` – the method by which the request was completed: "`fetch`" is regular HTTPS `fetch()`, `gun-ipns` means Gun and IPFS were used, etc.
- `state` – the state of the request (`running`, `error`, `success`)
The code in the browser window context is responsible for keeping a more permanent record of the URLs requested, the methods used, and the status of each, if needed.
diff --git a/config.js b/config.js
index aa05fbec83bdeea8478d583367fb53a16cd73932..dee8e37a84e25bae8def5f2b5c7166c1ee4162cf 100644
--- a/config.js
+++ b/config.js
@@ -12,7 +12,7 @@ self.SamizdatConfig.plugins["gateway-ipns"] = {
// the pubkey of the preconfigured IPNS node
ipnsPubkey: 'QmYGVgGGfD5N4Xcc78CcMJ99dKcH6K6myhd4Uenv5yJwiJ'
}
-self.SamizdatConfig.plugins["gun+ipfs"] = {
+self.SamizdatConfig.plugins["gun-ipns"] = {
// the pubkey of the preconfigured Gun user
gunPubkey: 'WUK5ylwqqgUorceQRa84qfbBFhk7eNRDUoPbGK05SyE.-yohFhTzWPpDT-UDMuKGgemOUrw_cMMYWpy6plILqrg'
}
diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md
index 781e082ba1ae8aaa093f51f5c2a2166a881ddc3f..dfcf2c86b1cbd575c758e6f7db820cd8f63c36ff 100644
--- a/docs/ARCHITECTURE.md
+++ b/docs/ARCHITECTURE.md
@@ -51,7 +51,7 @@ Whenever a resource is being fetched on a Samizdat-enabled site, the `service-wo
1. `fetch`, to use the upstream site directly if it is available,
1. `cache`, to display the site immediately from the cache in case regular `fetch` fails,
-1. `gun+ipfs`, in the background if `cache` call succeeded, otherwise as the active fetch handler.
+1. `gun-ipns`, in the background if `cache` call succeeded, otherwise as the active fetch handler.
If a background plugin `fetch()` succeeds, the result is added to the cache and will be immediately available on page reload.
diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md
index 1058424cb439cec649e45e529be80842ec9cbe6a..2e8ba3d1a5f98f91d9fb0d94f1d116a30b22f97f 100644
--- a/docs/DEPLOYMENT.md
+++ b/docs/DEPLOYMENT.md
@@ -5,7 +5,7 @@
Samizdat deployment is currently mostly a manual process. It involves:
1. getting the code
1. creating a [Gun](https://gun.eco/) account to push content addresses to
-1. replacing the Gun account public key in the `gun+ipfs` plugin code
+1. replacing the Gun account public key in the `gun-ipns` plugin code
1. deploying the code to your server
This is highly suboptimal; work is being done to design and implement a process that is more user-friendly and automated. In the meantime, you can deploy Samizdat by following these steps.
diff --git a/docs/OVERVIEW.md b/docs/OVERVIEW.md
index 345a7f1d1897ec38c182e3e122e1cd7301cccd82..2cad9b468762c8234dcd52ccb5e5b59e9628848a 100644
--- a/docs/OVERVIEW.md
+++ b/docs/OVERVIEW.md
@@ -149,7 +149,7 @@ When a request is made, plugins are used to handle it in the order defined in co
1. retrieval from local `cache`;
1. any other transport plugins (`IPFS`, or fetching content from other pre-configured endpoints).
-It is up to the website admin's to configure the plugins in a way that makes sense. For example, if using the [`gun+ipfs`](./../plugins/gun-ipfs.js) plugin, the admin needs to create a Gun account and populate the plugin's Gun public key variable. If using `IPNS`, the admin needs to populate the `IPNS` public key in the respective plugin. And if alternative HTTPS endpoints are used, it's up to the admin to populate their URLs.
+It is up to the website admin's to configure the plugins in a way that makes sense. For example, if using the [`gun-ipns`](./../plugins/gun-ipfs.js) plugin, the admin needs to create a Gun account and populate the plugin's Gun public key variable. If using `IPNS`, the admin needs to populate the `IPNS` public key in the respective plugin. And if alternative HTTPS endpoints are used, it's up to the admin to populate their URLs.
Examples of possible alternative HTTPS locations:
- an IP address or a domain controlled by the admin that is not linked to the original website and thus can be expected not to be blocked;
@@ -161,7 +161,7 @@ Examples of possible alternative HTTPS locations:
For content to be available for retrieval by transport plugins, it first needs to be published to whatever locations it is going to be retrieved from.
-For the `gun+ipfs` plugin, for instance, content needs to first be published in IPFS, and then the IPFS addresses for each file need to be published to Gun. Currently it is an involved process (example is available in the [CI/CD configuration for the project](./../.gitlab-ci.yml)); making it simpler and easier is the focus of current development.
+For the `gun-ipns` plugin, for instance, content needs to first be published in IPFS, and then the IPFS addresses for each file need to be published to Gun. Currently it is an involved process (example is available in the [CI/CD configuration for the project](./../.gitlab-ci.yml)); making it simpler and easier is the focus of current development.
For plugins relying on fetching content from alternative HTTPS locations, this can be as simple as deploying the content to the alternative IP address or domain name, pushing the content to WebArchive, putting the content in the Google Drive folder, or uploading it to the CloudFront location.
diff --git a/index.html b/index.html
index 7b40cbc7da35bb45a3f1832b0b9c704a6426e715..059b346ac25ee055e1030c0f8879576dda158171 100644
--- a/index.html
+++ b/index.html
@@ -40,7 +40,7 @@
<p>The list below contains all resources fetched in relation to this page.</p>
<ul class="samizdat-fetched-resources-list"></ul>
<p class="samizdat-fetched-resources-list-empty">The list is empty, but if the ServiceWorker is running it should be populated soon.</p>
- <p class="samizdat-fetched-resources-controls"><button type="button" onclick="samizdat.toggleResourceCheckboxes()">Toggle selection</button><span class="spacer"></span><button type="button" onclick="samizdat.stashOrUnstashResources(true)">Add selected to cache</button><button type="button" onclick="samizdat.stashOrUnstashResources(false)">Clear selected from cache</button><span class="spacer"></span><input type="text" placeholder="Gun username" id="samizdat-gun-user"/><input type="password" placeholder="Gun password" id="samizdat-gun-password"/><button type="button" onclick="samizdat.publishResourcesToGunAndIPFS()">Publish to Gun+IPFS</button></p>
+ <p class="samizdat-fetched-resources-controls"><button type="button" onclick="samizdat.toggleResourceCheckboxes()">Toggle selection</button><span class="spacer"></span><button type="button" onclick="samizdat.stashOrUnstashResources(true)">Add selected to cache</button><button type="button" onclick="samizdat.stashOrUnstashResources(false)">Clear selected from cache</button><span class="spacer"></span><input type="text" placeholder="Gun username" id="samizdat-gun-user"/><input type="password" placeholder="Gun password" id="samizdat-gun-password"/><button type="button" onclick="samizdat.publishResourcesToGunAndIPFS()">Publish to Gun and IPFS</button></p>
</div>
<p id="footer">ServiceWorker: <span class="samizdat-commit-service-worker">NO_INFO</span> :: index.html: <span class="samizdat-commit-index-html">COMMIT_UNKNOWN</span><br/>code: <span id="samizdat-code"><a href="https://0xacab.org/rysiek/samizdat/">here</a></span> :: news: <span id="samizdat-news"><a href="https://mastodon.social/tags/Samizdat">on Fediverse</a></span> :: license: <span id="samizdat-license"><a href="https://0xacab.org/rysiek/samizdat/blob/master/LICENSE">AGPL</a></span><br/><span id="samizdat-code-of-conduct"><a href="https://0xacab.org/rysiek/samizdat/blob/master/CODE_OF_CONDUCT.md">Code of Conduct</a></span></p>
</body>
diff --git a/plugins/gun-ipfs.js b/plugins/gun-ipfs.js
index 8fab65b8db256b4d388bc4b8098d8064cc0096ed..40bb88fdb4cc16433b6ef8c660a86c348af51a80 100644
--- a/plugins/gun-ipfs.js
+++ b/plugins/gun-ipfs.js
@@ -27,7 +27,7 @@
}
// merge the defaults with settings from SamizdatConfig
- let config = {...defaultConfig, ...self.SamizdatConfig.plugins["gun+ipfs"]}
+ let config = {...defaultConfig, ...self.SamizdatConfig.plugins["gun-ipns"]}
// reality check: Gun pubkey needs to be set to a non-empty string
if (typeof(config.gunPubkey) !== "string" || config.gunPubkey === "") {
@@ -211,7 +211,7 @@
'headers': {
'Content-Type': contentType,
'ETag': file.value.path,
- 'X-Samizdat-Method': 'gun+ipfs',
+ 'X-Samizdat-Method': 'gun-ipns',
'X-Samizdat-ETag': file.value.path
}
}
@@ -449,7 +449,7 @@
// and add ourselves to it
// with some additional metadata
self.SamizdatPlugins.push({
- name: 'gun+ipfs',
+ name: 'gun-ipns',
description: 'Decentralized resource fetching using Gun for address resolution and IPFS for content delivery.',
version: 'COMMIT_UNKNOWN',
fetch: getContentFromGunAndIPFS,
diff --git a/plugins/ipns-ipfs.js b/plugins/ipns-ipfs.js
index 53ef4cb2f8e8210cfc2bae51b52ddc37c70a3a22..b15715cf250582cdb1d55eb79e1be175b9421b63 100644
--- a/plugins/ipns-ipfs.js
+++ b/plugins/ipns-ipfs.js
@@ -168,7 +168,7 @@
'headers': {
'Content-Type': contentType,
'ETag': file.value.path,
- 'X-Samizdat-Method': 'gun+ipfs',
+ 'X-Samizdat-Method': 'gun-ipns',
'X-Samizdat-ETag': file.value.path
}
}
diff --git a/samizdat.js b/samizdat.js
index fcffc203b6d234bf8c3fdd3644c22fd549a95049..874043d1397184301d07fbc50b33cf393534796d 100644
--- a/samizdat.js
+++ b/samizdat.js
@@ -406,7 +406,7 @@ samizdat.stashOrUnstashResources = (stash=true) => {
/**
- * publishing certain resources to Gun+IPFS
+ * publishing certain resources to Gun and IPFS
*/
samizdat.publishResourcesToGunAndIPFS = () => {
var user = document.getElementById('samizdat-gun-user').value