Deploying a Speckle Server

Hello @SigveMartin! unfortunately, http does not come out of the box :frowning: It could, but then I would need to assume that you have a (sub)domain name ready that points to your IP in order to be able to automate these things with an nginx image and letsencrypt.

If you need one, just drop me a line and can try authoring one at *.speckle.xyz, which is unused at the moment.

Hi guys,

I’m testing Speckle and trying to set up an Ubuntu server for it. This is my first post here, please let me know if my question is too long (or broad/generic!), in case I will make a separate thread and try to be more specific.

I followed the Speckle-Server instructions on GitHub (“Deploying on Debian-based OSes”).
However I now find myself stuck, as the WebAPI seems to work, but I cannot connect to the main page of Speckle, nor use the server to register.

If I try to browser access the server at http//serverAddress:port/api/v1, the browser nicely responds with a JSON.

If I try to register through the GH plugin, I get a “failed to contact http//serverAddress:port/api/v1”

Finally, if I try to access the “root” HTTP address, the answer is a generic “Cannot /GET.”

I guess this last answer could be by design – I was trying to understand if I can access to the main Speckle “landing page” from this address.

My questions are then:

  1. Could anyone confirm that if I try to reach the address http //myserveraddress:port/ I should get to a sort of “Speckle landing page” such as the one in this image: Imgur: The magic of the Internet

  2. Has anyone any thoughts on this issue? I’ve been hitting my head on this for a while. Mongo, redis and node seems all running nicely on the Linux server.

Thanks!

Hello @Alessio_Lombardi! There have been some changes in the server, and I haven’t had the time to refresh the docs about it.

I figured it from your screenshot: no https but http. Things will work then in the plugins. Longer story: to have SSL going you’ll need a domain name, a reverse proxy and and a letsencrypt (or other) certificate. These things are usually best left to the IT department to set up, and vary differently on deployment scenarios, so there’s no guide for them. Though maybe a simple something could be written.

Regarding the landing page, we’ve recently switched to a plugin system and removed the npm dependencies on the speckle frontend packages, as that was an extra hassle to maintain. You now need to install them manually:

cd your_speckle_app_folder
cd plugins
git clone https://github.com/speckleworks/SpeckleAdmin.git # this is for the admin ui, will be served from the root
git clone https://github.com/speckleworks/SpeckleViewer.git # for the viewer, will be served from /view

To be sure you’ve got everyhting going ok, it is recommended that you build the plugins too after you clone them. This would mean running:

npm install
npm run build

In each of their folders. In theory (if i did my job correctly) it should not be necessary though.

[EDIT]
After the above, you will need to restart the server so that the plugins get picked up!

2 Likes

This is great, thank you so much. Up and running now!
Speckle is great. I’ll keep playing around with it to understand it better, also code-wise.
Thank you!

1 Like

Hello Anton, sorry to trouble you, im new to this, i am installing Speckle server and i have followed your steps, i am still unable to see the default webpage.
do i need to install IIS or nginx on windows 10?
regards,
H

Hi @hirji.patel, could you post a wee bit more details on what’s missing?

  • default webpage of the server, or
  • default webpage of the server
  • what does the console say? (hope there’s no errors there!)

If you’re missing the frontend application that’s a bit more complicated to set up in 1.0, especially on windows :grimacing:: You will need to clone the repo inside the plugins folder of the server installation, and then run - in the app’s folder - npm install and then npm run build.

Hello Dimitrie, i am missing frontend application, i did try to install it on Debian 10 but still didnt get the frontend to work; i can revert back to Debian and see i we can get it to work on there.

on Debian 10 i get following error:
502 Bad Gateway
nginx/1.14.

i followed this:

with this i can login into server and see desktop.

i dont see any error server boot right into login screen.

regards,
Hirji

If you’re deploying on a vps instance, it looks like the proxy pass from nginx is not set up correctly; make sure your ports match what’s there in the nginx server block!

Also, if you guys at akt need a server just to test things out, we can deploy for you for free a temporary instance, it’s usually faster than debugging remotely. Just let us know at hello [@] speckle.systems :slight_smile:

Y’all! Discourse is politely asking me “Revive this topic? The last reply to this topic was 7 months ago.” The answer is a resounding yes. @izzylys already updated the first post in this thread - which actually brought this to my attention - but I feel that a little bit more spam visibility is needed.

Chief Hacker Man @cristi did you all big favour and created a Digital Ocean One-Click Image for deploying a nice and minty Speckle Server v.2.0. More details in our annoucement :point_down:

PS: I can’t believe it took four years to get here, but hey - there’s been a major version bump!

3 Likes