Server startup

Socks server is written in JS and runs on V8 engine with Deno's runtime.

Server binaries are provided from version 0.2.0. If you don't need server customization, you're ready to go with them, if not, continue reading.

The first step is about installing and getting Deno running, it's dead simple, just check the guide on deno.land.

As for Socks 0.2.0 version, the recommended Deno version is 1.7.4, you can upgrade your version using:

deno upgrade --version 1.7.4

Once you get Deno running, you can try to execute the server with the following command:

deno run --allow-net --allow-read --allow-write .\server.js

The first time you run the server, dependencies will be downloaded, after that the server will startup faster.

The database files will be stored on the /data folder, so make sure you have permissions to write in there.

If everything is running OK, you should see the following messages on console:

The server comes with a pre-built web administration panel, which will run by default on port 7538. With it, you can manage most of your server data and events. Go to your browser and point to it:

The first registered user will get the administrator role by default, so make sure you are the first one to be registered on the system.

The web cpanel is developed with React, it's prebuilt on /client/build, but you can edit the source code in /client/src and run the build command (npm run build) after editing it.

Last updated