dashy icon indicating copy to clipboard operation
dashy copied to clipboard

[FEATURE_REQUEST] Improved documentation for Debian/Ubuntu

Open Aerowinder opened this issue 3 years ago • 5 comments

Is your feature request related to a problem? If so, please describe.

For people unfamiliar with Node/Yarn, the installation instructions provided from the Build from Source instructions (https://dashy.to/docs/deployment#build-from-source) are inadequate. I realize that this is supposed to be used as a Docker image, but Docker doesn't fit into everyone's environment. For instance, I use Docker at home but not at work.

Would you be willing to expand these instructions, and optionally add some scripting into the repo to make installation from source less of a manual process?

Describe the solution you'd like

I've created some basic scripts already that do work, but may not be the ideal way to do things. These work on Debian and should work on derivatives:

Install prereqs, Dashy, and create a new user we will use to run the service: cat > /opt/dashy-install.sh << EOF #prereq - must use LTS version of Node (v16) as v18 is not supported by one of the dependencies. apt update && apt install -y curl git curl -fsSL https://deb.nodesource.com/setup_16.x | bash - apt update && apt install -y nodejs npm install --global yarn

#install mkdir /opt/dashy cd /opt git clone https://github.com/Lissy93/dashy.git cd /opt/dashy yarn install yarn build

#create user useradd dashy -d /opt/dashy -M -r -s "$(which bash)" chown -R dashy:dashy /opt/dashy chmod 771 /opt/dashy EOF

Create start/update scripts. dashy-start.sh is used by systemd to start Dashy, dashy-update must be run manually cat > /opt/dashy-start.sh << EOF #!/bin/sh cd /opt/dashy yarn start EOF

cat > /opt/dashy-update.sh << EOF #!/bin/sh systemctl stop dashy cd /opt/dashy git pull origin master npm update yarn upgrade yarn build chown -R dashy:dashy /opt/dashy chmod 771 /opt/dashy systemctl start dashy EOF

chmod +x /opt/dashy-install.sh chmod +x /opt/dashy-start.sh chmod +x /opt/dashy-update.sh

Create systemd service file so you can control Dashy with systemctl start/stop: cat > /etc/systemd/system/dashy.service << EOF [Unit] Description=Dashy Daemon After=network.target

[Service] User=dashy Group=dashy Type=mixed ExecStart=/opt/dashy-start.sh TimeoutStopSec=30 KillMode=mixed Restart=never

[Install] WantedBy=multi-user.target EOF

systemctl daemon-reload systemctl enable dashy.service systemctl start dashy.service

Priority

Low (Nice-to-have)

Is this something you would be keen to implement

Maybe

Aerowinder avatar Aug 22 '22 14:08 Aerowinder

If you're enjoying Dashy, consider dropping us a ⭐
🤖 I'm a bot, and this message was automated

liss-bot avatar Aug 22 '22 14:08 liss-bot

This issue has gone 6 weeks without an update. To keep the ticket open, please indicate that it is still relevant in a comment below. Otherwise it will be closed in 5 working days.

liss-bot avatar Sep 22 '22 01:09 liss-bot

Is this still open for improvements, or not !

averrois avatar Jan 16 '24 17:01 averrois

Is this still open for improvements, or not ! @averrois

It's GitHub, yeah just comment!

Will look into this in the next time, however I will probably wait for 2.1.2 because there are many fixes.

CrazyWolf13 avatar Feb 28 '24 20:02 CrazyWolf13

@CrazyWolf13 Yeah, I am kind new to open source lol, okay then I will wait until 2.1.2, then if I find any issues that I could contribute too, it will be an honor to do so

averrois avatar Feb 28 '24 20:02 averrois