-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: remove global css to style css + update readme + add toolti…
…ps and alerts Co-authored-by: [email protected] <[email protected]>
- Loading branch information
1 parent
eef5901
commit 3afec35
Showing
13 changed files
with
109 additions
and
178 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,82 @@ | ||
# fl-server frontend | ||
|
||
## Description | ||
|
||
`rfs frontend` is a frontend to manage rfs server to create, mount and extract FungiStore lists (FungiList)`fl` for short. An `fl` is a simple format | ||
to keep information about an entire filesystem in a compact form. It does not hold the data itself but enough information to | ||
retrieve this data back from a `store`. | ||
`Threefold RFS` is a frontend that helps manage the RFS server for creating, mounting, and extracting FungiStore lists, or fl for short. An fl is a simple format that stores information about a whole filesystem in a compact way. It doesn't hold the actual data but includes enough details to retrieve the data from a store. | ||
|
||
## Prerequesites | ||
|
||
- build essentials | ||
|
||
```bash | ||
sudo apt-get install build-essential | ||
``` | ||
|
||
- [node js](https://nodejs.org/en/download/package-manager) | ||
- [rust](https://www.rust-lang.org/tools/install) | ||
- Cargo , to be configured to run in the shell | ||
- musl tool | ||
|
||
```bash | ||
sudo apt install musl-tools | ||
``` | ||
|
||
## Installation | ||
|
||
```bash | ||
git clone https://github.com/threefoldtech/rfs.git | ||
``` | ||
#### backend | ||
In fl-server dir: | ||
- create flists dir containaing dirs for each user | ||
- include config file | ||
ex: | ||
```yml | ||
host='localhost' | ||
port=4000 | ||
store_url=['dir:///tmp/store0'] | ||
flist_dir='flists' | ||
|
||
jwt_secret='secret' | ||
jwt_expire_hours=5 | ||
|
||
[[users]] # list of authorized user in the server | ||
username = "user1" | ||
password = "password1" | ||
|
||
[[users]] | ||
username = "user2" | ||
password = "password2" | ||
``` | ||
|
||
- execute the following command to run the backend: | ||
|
||
``` bash | ||
cargo run --bin fl-server -- --config-path config.toml | ||
``` | ||
#### frontend | ||
|
||
- execute the following command to run the frontend: | ||
```bash | ||
npm install | ||
npm run dev | ||
``` | ||
|
||
### backend | ||
|
||
In fl-server dir: | ||
|
||
- create flists dir containaing dirs for each user | ||
ex: | ||
- fl-server | ||
- flists | ||
- user1 | ||
- user2 | ||
- include config file | ||
ex: | ||
|
||
```yml | ||
host='localhost' | ||
port=4000 | ||
store_url=['dir:///tmp/store0'] | ||
flist_dir='flists' | ||
jwt_secret='secret' | ||
jwt_expire_hours=5 | ||
[[users]] # list of authorized user in the server | ||
username = "user1" | ||
password = "password1" | ||
[[users]] | ||
username = "user2" | ||
password = "password2" | ||
``` | ||
|
||
- Move to `fl-server` directory and execute the following command to run the backend: | ||
|
||
```bash | ||
cargo run --bin fl-server -- --config-path config.toml | ||
``` | ||
|
||
### frontend | ||
|
||
- Move to `frontend` directory and execute the following commands to run the frontend: | ||
|
||
```bash | ||
npm install | ||
npm run dev | ||
``` | ||
|
||
## Usage | ||
- Create Flist | ||
|
||
- Login with users listed in config.toml with their username and password | ||
- Create Flist | ||
- Preview Flist | ||
- List all Flists | ||
- Download Flist | ||
- Download Flist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.