Projects on Fleek
All platform usage will be tied to a project, so it is mandatory to have a project selected. Any user can create a project, and access can be granted to any user by providing an email address. An account can be the owner of one or more projects and, at the same time, can belong to projects owned by other accounts.
Creating a new project
As soon as you sign up, an initial project is created for you by default. This project starts with a placeholder name and remains blank until you decide otherwise. You’re free to alter the project’s name whenever you wish. In the application you will find your project in the top left corner of the screen, next to the Fleek logo. Clicking on the project name will open a dropdown with all the projects you have access to. The selected project will be marked with a checkmark.
To create a new project, click on the ‘Projects’ dropdown and select the ‘Create project’ option. You will be prompted to enter a name for the project. Once you have entered the name, click on the ‘Create’ button and the project will be created. You will be redirected to the project dashboard.
Changing project name
To change the project name you can click on the ‘Settings’ icon in the project dashboard. You will be prompted to enter a new name for the project. Once you have entered the name, click on the ‘Save’ button and the project name will be updated.
Deleting a project
To remove a project, navigate to the project dashboard and click the ‘Settings’ icon. All of the data inside the project will be removed from the platform, including:
- All of the sites
- All of the domains linked to the sites
- All of the IPNS keys linked to the sites
- All of the private gateways
- All of the domains linked to the private gateways
- All of the files stored
Once you have confirmed the deletion, the project will be deleted. This action is irreversible.
Invitations
Invitations are a way to grant access to a another user to one of your projects. The invited users will be able to perform most of the actions that the owner of the project can take, such as:
- Managing sites
- Managing domains
- Managing files
- Managing gateways
…but will be restricted from taking other actions, such as:
- Deleting the project
- Inviting new members
Inviting a new user
To invite a new user into your project, go to the project’s ‘Settings’ page and select the ‘Teams’ tab. There you will find a list of members in the project and a button to generate a link to invite a new user.
This is a unique link that will grant project access to a single user. Once the user has used the link to access the project, the link will be invalidated and a new link will need to be generated to invite a new user. This link is not tied to the authentication method used to access the project, so the user can choose to use their wallet or e-mail account to access the project.
Permissions
The Fleek platform uses a role-based system for managing permissions. Certain features are only accessible to users with specific roles. For a detailed breakdown of these permissions, see the table provided below.
Owner | Admin | Member | Read Only | |
---|---|---|---|---|
Project | ||||
Edit name | ✅ | ✅ | ✅ | ❌ |
Edit avatar | ✅ | ✅ | ✅ | ❌ |
Delete project | ✅ | ❌ | ❌ | ❌ |
Storage | ||||
Edit settings | ✅ | ✅ | ❌ | ❌ |
Upload files/folders | ✅ | ✅ | ✅ | ❌ |
Edit files/folders name | ✅ | ✅ | ✅ | ❌ |
Delete files/folders | ✅ | ✅ | ✅ | ❌ |
Get information | ✅ | ✅ | ✅ | ✅ |
View content list | ✅ | ✅ | ✅ | ✅ |
Sites | ||||
Create site | ✅ | ✅ | ✅ | ❌ |
Deploy site | ✅ | ✅ | ✅ | ❌ |
View site overview | ✅ | ✅ | ✅ | ✅ |
View build settings | ✅ | ✅ | ✅ | ✅ |
Edit build settings | ✅ | ✅ | ✅ | ❌ |
View environment variables | ✅ | ✅ | ✅ | ✅ |
Edit environment variables | ✅ | ✅ | ✅ | ❌ |
View deployments list | ✅ | ✅ | ✅ | ✅ |
View analytics | ✅ | ✅ | ✅ | ✅ |
Edit site name | ✅ | ✅ | ✅ | ❌ |
Edit site slug | ✅ | ✅ | ✅ | ❌ |
Edit site avatar | ✅ | ✅ | ✅ | ❌ |
Purge cache | ✅ | ✅ | ✅ | ❌ |
Delete site | ✅ | ✅ | ❌ | ❌ |
Add and verify domain | ✅ | ✅ | ✅ | ❌ |
Change primary domain | ✅ | ✅ | ✅ | ❌ |
Delete domain | ✅ | ✅ | ✅ | ❌ |
Add and verify ENS | ✅ | ✅ | ✅ | ❌ |
Delete ENS | ✅ | ✅ | ✅ | ❌ |
Add Git integration | ✅ | ✅ | ✅ | ❌ |
Remove Git integration | ✅ | ✅ | ❌ | ❌ |
Fleek Functions | ||||
Create function | ✅ | ✅ | ✅ | ❌ |
Edit settings | ✅ | ✅ | ✅ | ❌ |
View function overview | ✅ | ✅ | ✅ | ✅ |
Deploy function | ✅ | ✅ | ✅ | ❌ |
Delete function | ✅ | ✅ | ✅ | ❌ |
IPNS | ||||
Create a record | ✅ | ✅ | ✅ | ❌ |
Publish a record | ✅ | ✅ | ✅ | ❌ |
Delete a record | ✅ | ✅ | ✅ | ❌ |
View records | ✅ | ✅ | ✅ | ✅ |
Billing | ||||
View billing | ✅ | ✅ | ❌ | ❌ |
Manage billing | ✅ | ❌ | ❌ | ❌ |
Application credentials | ||||
View | ✅ | ✅ | ✅ | ✅ |
Create | ✅ | ✅ | ✅ | ❌ |
Edit | ✅ | ✅ | ✅ | ❌ |
Team | ||||
Invite team members | ✅ | ✅ | ❌ | ❌ |
Change member permissions | ✅ | ✅ | ❌ | ❌ |
Assign owner | ✅ | ❌ | ❌ | ❌ |
Delete member | ✅ | ✅ | ❌ | ❌ |
Application credentials
Application credentials are the keys to your project. They are used to authenticate your application with the Fleek Storage. Their use is currently limited to uploading files and directories.
Whitelist domains
You can whitelist domains for each application credential. This means that the application credential will only be able to make requests to the domains that are whitelisted. This is useful from a security standpoint, as it prevents unauthorized access to your project.
Creating application credentials
To create an application credential, follow these steps:
- Go to the Fleek dashboard.
- Select the project you want to create an application credential for.
- Click on the
Settings
tab. - Click on the
Application Credentials
tab. - Click on the
Create Application Credential
button. - Enter a name for the application credential.
- Whitelist domains for the application credential.
- Click on the
Create
button. - Copy the application token.
You can now use the application token to authenticate your application with Fleek’s services like the SDK.
Managing application credentials
You can manage your application credentials by going to the Application Credentials
tab in the Settings
page of your project, within the Fleek dashboard. Here you can view, edit, and delete your application credentials.
Updating whitelisted domains
You can update, add or remove whitelisted domains for an application credential by clicking on the Edit
button next to the application credential in the Application Credentials
tab in the Settings
page of your project, within the Fleek dashboard.