"Get Fleek Network" is an attempt to make our software more accessible. By providing scripts to automate the installation process of our software, we believe that it can help improve the onboarding experience of our users.
The practice of "piped installers" has become widespread in recent years, as development teams try to help the users by providing an easy installation process, but that has security risks.
💡 A "pipe installer" is a term used to describe curl get.example.com/script.sh | bash
, which is a curl
request that pipes a file that it gets from a remote location into the bash interpreter which is used to allow you to interact with your operating system. You can find these "pipe installers" in Rust, Docker, etc; although they all are written differently and for different purposes and intent.
We try to reduce this risk by reducing the number of operations by informing and requesting permission from the user, which has to provide consent.
As a user, you are strongly advised to follow our Introductory Guides instead. Otherwise, run the "pipe installer" at your own risk!
All things considered, we advise you to read the source code which is publicly available in the repository to understand the process and make a decision of your own, about whether you find it safe to run the assisted installer or not.
👍 Alternatively, you may find the installation script that is provided as a good reference to follow on your own.
If you have any questions or feedback, find us on Discord.
- Bash >= 4.2
Open a new terminal window, and connect to a supported Linux server.
curl https://get.fleek.network | bash
Learn more about the assisted installer here
You may find that by starting a server, serving the static files in the root
npx http-server .
Can serve to test in a container, e.g. such as Ubuntu.
docker run -it ubuntu /bin/bash
It's partial support, as docker in docker is not available if you're willing to run the whole process. Thus, a VM or VPS might be a better choice during development.
Our documentation is available at https://docs.fleek.network/ where you can find guides, and references to help you! We do our best to provide you with the best onboarding experience, but as we keep developing there are a lot of changes and some troubleshooting might be required, and thus important to use our documentation and guides.
- The domain name
get.fleek.network
should have a CNAME record to the Github pagesfleek-network.github.io
.` - A Github action prepares and deploys to Github pages, the latest of the assisted install
- The cURL request to
get.fleek.network
responds with the assisted install script - Uses bash on runtime
Create branches from the main
branch and name it in accordance with conventional commits** here, or follow the examples below:
test: 💍 Adding missing tests
feat: 🎸 A new feature
fix: 🐛 A bug fix
chore: 🤖 Build process or auxiliary tool changes
docs: ✏️ Documentation only changes
refactor: 💡 A code change that neither fixes a bug or adds a feature
style: 💄 Markup, white-space, formatting, missing semi-colons...
Find more about contributing here, please!