a04160976d
Bump engine.io from 4.1.1 to 4.1.2 in /packages/website |
||
---|---|---|
.github | ||
changelog | ||
docker | ||
packages | ||
scripts | ||
setup-scripts | ||
.gitignore | ||
.prettierignore | ||
CHANGELOG.md | ||
LICENSE.md | ||
README.md | ||
dc | ||
docker-compose.abuse.yml | ||
docker-compose.accounts.yml | ||
docker-compose.blocker.yml | ||
docker-compose.jaeger.yml | ||
docker-compose.malware-scanner.yml | ||
docker-compose.mongodb.yml | ||
docker-compose.uploads.yml | ||
docker-compose.yml |
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
tomongodb:mongodb
- Change its permissions to 400
- Change the ownership of
- 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:
- In one terminal screen run
GATSBY_API_URL=https://siasky.net website serve
- 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.