A webapp that makes Skynet accessible to web browsers.
This repository has been archived on 2022-10-07. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
dependabot[bot] 2cca1af90c
Bump react-use from 17.3.1 to 17.3.2 in /packages/website
Bumps [react-use](https://github.com/streamich/react-use) from 17.3.1 to 17.3.2.
- [Release notes](https://github.com/streamich/react-use/releases)
- [Changelog](https://github.com/streamich/react-use/blob/master/CHANGELOG.md)
- [Commits](https://github.com/streamich/react-use/compare/v17.3.1...v17.3.2)

---
updated-dependencies:
- dependency-name: react-use
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-01-03 12:08:39 +00:00
.github blocklist improvements 2021-12-20 13:12:56 +01:00
changelog Merge branch 'master' of https://github.com/SkynetLabs/skynet-webportal into pj/mail-scanner 2021-12-20 13:46:36 +01:00
docker fix skapp link redirect 2021-12-21 16:29:41 +01:00
packages Bump react-use from 17.3.1 to 17.3.2 in /packages/website 2022-01-03 12:08:39 +00:00
scripts Cleanup Kratos, Oathkeeper, CockroachDB. 2021-12-16 13:08:35 +02:00
setup-scripts Cleanup Kratos, Oathkeeper, CockroachDB. 2021-12-16 13:08:35 +02:00
.gitignore Cleanup Kratos, Oathkeeper, CockroachDB. 2021-12-16 13:08:35 +02:00
.prettierignore Accounts (#554) 2021-04-01 15:15:37 +02:00
CHANGELOG.md Update changelog for v0.1.3 2021-10-18 15:46:54 -04:00
LICENSE.md change license to custom 2021-03-15 12:58:02 +01:00
README.md Cleanup Kratos, Oathkeeper, CockroachDB. 2021-12-16 13:08:35 +02:00
dc Merge branch 'master' of https://github.com/SkynetLabs/skynet-webportal into pj/mail-scanner 2021-12-20 13:46:36 +01:00
docker-compose.abuse.yml Update env vars 2021-12-20 16:43:56 +01:00
docker-compose.accounts.yml Cleanup Kratos, Oathkeeper, CockroachDB. 2021-12-16 13:08:35 +02:00
docker-compose.blocker.yml Move blocker from .102 to .110 2021-12-14 11:10:15 +02:00
docker-compose.jaeger.yml adjust docker services logging (missing ones) 2021-07-12 13:58:25 +02:00
docker-compose.malware-scanner.yml Add blocker ip and port env vars. 2021-12-14 12:04:07 +02:00
docker-compose.mongodb.yml Add default value to skynet replicaset 2021-10-18 12:12:58 +02:00
docker-compose.uploads.yml Accounts (#554) 2021-04-01 15:15:37 +02:00
docker-compose.yml Add a new volume that allows blocker to write to nginx's local disk. 2021-12-09 17:51:40 +01:00

README.md

Skynet Portal

Web application

Change current directory with cd packages/website.

Use yarn start to start the development server.

Use yarn build to compile the application to /public directory.

You can use the below build parameters to customize your web application.

  • development example GATSBY_API_URL=https://siasky.dev yarn start
  • production example GATSBY_API_URL=https://siasky.net yarn build

List of available parameters:

  • GATSBY_API_URL: override api url (defaults to location origin)

License

Skynet uses a custom License. The Skynet License is a source code license that allows you to use, modify and distribute the software, but you must preserve the payment mechanism in the software.

For the purposes of complying with our code license, you can use the following Siacoin address:

fb6c9320bc7e01fbb9cd8d8c3caaa371386928793c736837832e634aaaa484650a3177d6714a

MongoDB Setup

Mongo needs a couple of extra steps in order to start a secure cluster.

  • Open port 27017 on all nodes that will take part in the cluster. Ideally, you would only open the port for the other nodes in the cluster.
  • Manually add a mgkey file under ./docker/data/mongo with the respective secret ( see Mongo's keyfile access control for details).
  • Manually run an initialisation docker run with extra environment variables that will initialise the admin user with a password (example below).
  • During the initialisation run mentioned above, we need to make two extra steps within the container:
    • Change the ownership of mgkey to mongodb:mongodb
    • Change its permissions to 400
  • After these steps are done we can open a mongo shell on the primary node and run rs.add() in order to add the new node to the cluster. If you don't know which node is primary, log onto any server and jump into the Mongo's container (docker exec -it mongo mongo -u admin -p) and then get the status of the replica set (rs.status()).

Example initialisation docker run command:

docker run \
	--rm \
	--name mg \
	-p 27017:27017 \
	-e MONGO_INITDB_ROOT_USERNAME=<admin username> \
	-e MONGO_INITDB_ROOT_PASSWORD=<admin password> \
	-v /home/user/skynet-webportal/docker/data/mongo/db:/data/db \
	-v /home/user/skynet-webportal/docker/data/mongo/mgkey:/data/mgkey \
	mongo --keyFile=/data/mgkey --replSet=skynet

Regular docker run command:

docker run \
	--rm \
	--name mg \
	-p 27017:27017 \
	-v /home/user/skynet-webportal/docker/data/mongo/db:/data/db \
	-v /home/user/skynet-webportal/docker/data/mongo/mgkey:/data/mgkey \
	mongo --keyFile=/data/mgkey --replSet=skynet

Cluster initialisation mongo command:

rs.initiate(
  {
    _id : "skynet",
    members: [
      { _id : 0, host : "mongo:27017" }
    ]
  }
)

Add more nodes when they are ready:

rs.add("second.node.net:27017")

Contributing

Testing Your Code

Before pushing your code, you should verify that it will pass our online test suite.

Cypress Tests Verify the Cypress test suite by doing the following:

  1. In one terminal screen run GATSBY_API_URL=https://siasky.net website serve
  2. In a second terminal screen run yarn cypress run

Setting up complete skynet server

A setup guide with installation scripts can be found in setup-scripts/README.md.