diff --git a/.vitepress/config.mts b/.vitepress/config.mts index a262730..6e87000 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -95,7 +95,17 @@ export default withMermaid({ ] }, { - text: 'Using Codex', + text: 'Setup Codex with Installer', + collapsed: false, + items: [ + { text: 'Disclaimer', link: '/codex/installer-disclaimer' }, + { text: 'Requirements', link: '/learn/installer/requirements' }, + { text: 'Install and Run Codex', link: '/learn/installer/install-and-run' }, + { text: 'Upload/Download', link: '/learn/installer/upload-and-download' }, + ] + }, + { + text: 'Setup Codex Manually', collapsed: false, items: [ { text: 'Disclaimer', link: '/codex/disclaimer' }, diff --git a/codex/installer-disclaimer.md b/codex/installer-disclaimer.md new file mode 100644 index 0000000..bce86b7 --- /dev/null +++ b/codex/installer-disclaimer.md @@ -0,0 +1,103 @@ +# Codex Testnet Privacy Policy + +This Privacy Policy applies exclusively when you access the Codex testnet through the Command Line Interface (CLI) installer provided by us. It is designed to inform you about the personal data we collect and process, our approach to that collection and processing, and your rights when you participate in the Codex Testnet Programme using our CLI installer. For the avoidance of doubt, your participation in the Codex Testnet Programme is subject to the [Codex Testnet Terms and Conditions](https://docs.codex.storage/networks/testnet). + +Before using the CLI installer to participate in the Codex Testnet Programme, please review this privacy policy carefully. By agreeing to use our CLI installer to participate in the Codex Testnet Programme, you acknowledge that this Privacy Policy is applicable to your use of the testnet through our provided CLI tool. + +## Who We Are + +For the purposes of this Privacy Policy and the collection and processing of personal data as a controller, the relevant entity is **IFT Studio Pte Ltd.**, a company duly organised and registered under the laws of Singapore, having its registered office at: + +**160 Robinson Road, #24-09, Singapore 068914** + +Whenever we refer to **“IFT”**, **“we”**, **“us”**, or any other similar references, we are referring to IFT Studio Pte Ltd. + +## Data Collection and Processing + +We limit the collection and processing of personal data from your participation in the Codex Testnet Programme. We only collect and process certain personal data for specific purposes and where we have the legal basis to do so under applicable data protection law, and in this case, with your explicit consent. + +We will not collect or process any personal data that we don’t need, and where we do store any personal data, we will only store it for the least amount of time needed for the indicated purpose. + +### Personal Data We Collect + +We collect and process the following personal data as a result of your participation in the Codex Testnet Programme: + +#### **Wallet Addresses** +In order to provide you with Codex Testnet tokens and facilitate your participation in the Codex Testnet Programme, we may collect and process two types of blockchain addresses from you. This data processing is necessary for the performance of our contract with you to participate in the testnet. + +The information we collect includes: + +- **Codex testnet address** – Used to distribute Codex testnet tokens, allowing you to interact with the storage contracts and trigger “persistence mode” on the Codex testnet. +- **Live L1/L2 Ethereum public address** – Used for potential future network-related distributions and community engagement initiatives. + +These addresses are collected through our automated CLI installer or can be manually submitted via our Discord bot, depending on your method of installation. Your participation in the testnet and provision of these addresses constitutes your agreement to this data collection and processing. + +You have the right to withdraw from the Codex testnet at any time, in which case we will cease processing this data. + +#### **Node and Network Information** +To improve the future functionality, performance, and security of Codex, we collect and process technical information from users participating in the Codex testnet. We rely on our **legitimate interest** as the legal basis for this data processing activity. + +The information we collect includes: + +- **Node ID** +- **Peer ID** +- **Public IP address** +- **Codex node version** +- **Number of connected peers** +- **Discovery and listening ports** +- **Discord Handle** (associated with your Node ID) + +We will retain this data only for as long as strictly necessary to fulfill the purposes outlined above and in compliance with applicable privacy laws. + +While we believe this data processing is necessary and proportionate to our legitimate interests, you may exercise your **right to object** or any other rights available to you as set out in this Privacy Policy and applicable data protection law. + +> **Note:** Opting out may prevent you from being able to participate in the testnet. + +We are committed to **data minimization** and **purpose limitation**. After the mainnet launch of Codex, all personal data collected during the testnet phase will be securely deleted. + +## Third-Party Processing of Personal Data + +In addition to our limited collection of personal data, **third parties may collect or process your personal data** as part of your participation in the Codex Testnet Programme, particularly when we use their services to facilitate your participation. + +When you interact with these third parties, **their respective privacy policies will govern** the collection and use of your data. We encourage you to review these privacy policies to understand how your personal data may be handled by these third parties. + +## Security Measures We Take + +As a general approach, we take **data security** seriously and have implemented a variety of **security measures** to maintain the safety of your personal data when you submit such information to us. + +## Exporting Personal Data Outside Singapore + +We are obliged to protect the privacy of personal data that you may have submitted in the unlikely event that we export your personal data outside Singapore. + +This means that personal data will only be processed in **countries or by parties that provide an adequate level of protection** comparable to the relevant data protection laws in Singapore. Otherwise, we will use **other forms of protections**, such as specific **contractual clauses**, to ensure such personal data is provided the same protection as required under such legislation. + +In any event, the transmission of personal data outside Singapore will always occur in conformity with applicable data protection laws. + +## Your Choices and Rights + +As explained in this Privacy Policy, we **limit our collection and processing** of your personal data wherever possible. Nonetheless, you still have certain **choices and rights** regarding the personal data we do collect and process. + +According to relevant privacy legislation, you have the right to: + +- **Request corrections or updates** to your personal data (where reasonably possible). +- **Request the removal** of your personal data from our systems. +- **Request a copy** of your personal data, which may also be transferred to another data controller at your request. +- **Withdraw your consent** to process your personal data (only if consent was asked for a processing activity). This only affects processing activities based on consent and does not affect the validity of such processing before withdrawal. +- **Object to the processing** of your personal data. +- **File a complaint** with the Personal Data Protection Committee of Singapore (PDPC) if you believe your personal data has been processed unlawfully. + +## This Privacy Policy Might Change + +We may modify or replace any part of this Privacy Policy **at any time and without notice**. Please check the Privacy Policy periodically for any changes. + +> **Note:** The new Privacy Policy will be effective **immediately** upon posting. + +## Contact Information + +If you have any questions about the Privacy Policy, please contact us at: + +📧 **legal@free.technology** + +--- + +**This document is licensed under [CC-BY-SA](https://creativecommons.org/licenses/by-sa/4.0/).** diff --git a/learn/installer/install-and-run.md b/learn/installer/install-and-run.md new file mode 100644 index 0000000..133ecd9 --- /dev/null +++ b/learn/installer/install-and-run.md @@ -0,0 +1,48 @@ +# Quick Start + +Codex Installer is a CLI tool that simplifies the process of setting up a Codex node. It handles all the necessary steps to get your node running quickly and efficiently. + +> Before we get started, please make sure to review and accept the [disclaimer](/codex/installer-disclaimer) as Codex Installer collects some of your node information to improve the user experience. + +
+ + + +## Requirements + +- git +- npm + +## Run the Codex Installer + +To start the Codex Installer, simply run the following command in your terminal : + +```bash +npx codexstorage +``` + +## Download and install Codex + +Once you run the above command, you will be seeing a command line interface with various options as below : + +![InstallCodex](/learn/codex-installer.png) + +On selecting the `Download and install Codex` option, you will be asked to agree to the privacy disclaimer and provide an installation path to finish your installation. If you do not wish to agree to the data collection disclaimer, you can select the `Exit` option and follow the instructions [Manual setup](/learn/quick-start.md) to install Codex without using the Installer. + +## Run the Codex node + +Upon selecting the `Run Codex node` option, you will be asked for your Listening port (default is 8070) and discovery port (default is 8090). You can optionally provide your ERC20 public address to associate your testnet node with your wallet (Please note that Codex does not promise any incentives for running a node yet). + +![RunCodex](/learn/codex-installer2.png) + +Keep this terminal window open as closing this will terminate your node. + +## Get the *ALTRUISTIC MODE* role on Codex discord + +With that, your Codex node should be up and running. You can check the information and status of your node by proceeding to the third option. + +![Get Role](/learn/codex-installer3.png) + +To claim the *ALTRUISTIC MODE* role, join the [Codex Discord](https://discord.gg/codex-storage) and go to the #bot channel. Run the `/node ` command where `` can be found in the Node Information menu in your Installer. + +In order to keep your role, you will be required to frequently interact with the Codex testnet by running your node and/or [uploading/downloading files](/learn/installer/upload-and-download.md) using the testnet. \ No newline at end of file diff --git a/learn/installer/requirements.md b/learn/installer/requirements.md new file mode 100644 index 0000000..1f720a7 --- /dev/null +++ b/learn/installer/requirements.md @@ -0,0 +1,23 @@ +# Requirements + +> **Note:** Using the Codex Installer is the recommended only if you agree to provide your node information to make the Codex experience better. If you don't agree to the disclaimer, please consider [setting up Codex manually](/learn/quick-start.md) + +
+ +To make sure that your Codex node is running smoothly, you will need to make sure that your machine has the following requirements : + +## Dependencies + +- git +- npm + +## Port Forwarding + +Codex requires two ports to be open on your machine in order to function properly. However, please note that the **ports provided below are configurable** based on your preference : + + | Protocol | Service | Port | + | -------- | --------- | ------ | + | UDP | Discovery | Default : `8090` | + | TCP | Transport | Default : `8070` | + +If you are not familiar with port forwarding, you can follow the instructions [here](https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/). \ No newline at end of file diff --git a/learn/installer/upload-and-download.md b/learn/installer/upload-and-download.md new file mode 100644 index 0000000..04f36ff --- /dev/null +++ b/learn/installer/upload-and-download.md @@ -0,0 +1,27 @@ +# Upload/Download Files in the Testnet + +You can either upload or download files by using the Upload / Download option in the Codex Installer or by using the Codex GUI app (recommended). + +## Codex Vault + +Codex Vault is a GUI web application that can help you interact with the Codex testnet by uploading and downloading files. Once you have your Codex node running using the installer, you can access the Codex Vault by going to https://app.codex.storage + +![Codex Vault](/learn/codex-vault.png) + +Ensure that you have all the necessary conditions checked in the 'health check' section before you try uploading or downloading files. + +### Uploading and Downloading Files + +To upload a file, you can either drag and drop the file to the upload area or click on the 'upload' button. You will be able to find a unique CID for the file once it has been uploaded. + +To download a file, enter the CID of the file in the 'download' section and click on the 'download' button. + +![Upload and Download](/learn/upload-download.png) + +## What's next? + +Now that you know how to upload and download files in the testnet, you can try to explore some experimental features and build your own applications on top of Codex : + +- [Use Codex REST API](/learn/using) +- [Running Codex with Local Marketplace support](/learn/local-marketplace) +- [Build applications using codex-js Library](https://github.com/codex-storage/codex-js) \ No newline at end of file diff --git a/learn/what-is-codex.md b/learn/what-is-codex.md index 543db17..d8096fd 100644 --- a/learn/what-is-codex.md +++ b/learn/what-is-codex.md @@ -4,6 +4,8 @@ Codex is a decentralised data storage protocol. Its primary features are strong
+

+ ### Motive The remote storage landscape is dominated by an increasingly small number of internet powerhouses—Google, Microsoft, Amazon, etc. While these services score highly in terms of user experience and convenience, centralised cloud data storage suffers from the following drawbacks: diff --git a/public/learn/codex-installer.png b/public/learn/codex-installer.png new file mode 100644 index 0000000..d8b4db0 Binary files /dev/null and b/public/learn/codex-installer.png differ diff --git a/public/learn/codex-installer2.png b/public/learn/codex-installer2.png new file mode 100644 index 0000000..628f10d Binary files /dev/null and b/public/learn/codex-installer2.png differ diff --git a/public/learn/codex-installer3.png b/public/learn/codex-installer3.png new file mode 100644 index 0000000..334eae2 Binary files /dev/null and b/public/learn/codex-installer3.png differ diff --git a/public/learn/codex-vault.png b/public/learn/codex-vault.png new file mode 100644 index 0000000..7e15243 Binary files /dev/null and b/public/learn/codex-vault.png differ diff --git a/public/learn/upload-download.png b/public/learn/upload-download.png new file mode 100644 index 0000000..11b1cff Binary files /dev/null and b/public/learn/upload-download.png differ