| At line 1 changed one line |
| Linux Instructions |
| Every linux distro is slightly different. This guide is intended to cover the basics and show you around some of the ways you can configure and work with CrushFTP. You can try the single line in Linux for an automated download and install...may work on most distros.\\ |
| {{{ |
| wget -O - https://www.crushftp.com/crush10wiki/attach/Linux%20Install/configure.sh | bash |
| }}} |
| At line 3 removed 2 lines |
| Every linux distro is slightly different. This guide is intended to cover the basics and show you around some of the ways you can configure and work with CrushFTP. |
|
| At line 7 changed one line |
| Java |
| __Java__ |
| At line 9 changed one line |
| First, make sure Java is installed properly. By default most linux distros come with a free version of Java that won't work with CrushFTP. Make sure its an official Sun java, or other suitable JVM. |
| CrushFTP10 requires Java 17 to run. First, check if there is a Java/openJDK 17 runtime available on the host, by default most linux distros come with an open source version of Java that may not work with CrushFTP. If there is none, download the latest openJDK tarball for your OS platform ( AMD64 or ARM) from [https://jdk.java.net/archive/|https://jdk.java.net/archive/], untar it into the CrushFTP10 installation folder then rename the resulting jdk-17 folder to Java |
| At line 12 added one line |
|
| At line 13 changed one line |
| java -version |
| {{{java -version}}} |
| At line 15 changed one line |
| If it mentions GNU, its not the right one. |
| If it is the wrong version\\ |
| {{{ |
| wget https://download.java.net/java/GA/jdk17.0.2/dfd4a8d0985749f896bed50d7138ee7f/8/GPL/openjdk-17.0.2_linux-x64_bin.tar.gz |
| tar -xvf openjdk-17.0.2_linux-x64_bin.tar.gz |
| /bin/rm openjdk-17.0.2_linux-x64_bin.tar.gz |
| mv jdk-17* /var/opt/CrushFTP10/Java |
| }}} |
| Then check if the init script detected it, run from within the CrushFTP10 installation the |
| {{{ |
| ./crushftp_init.sh info |
| }}} |
| command.\\ |
| ---- |
| At line 17 changed one line |
| To run Java, you may need to specify the full path to the java binary. Something possibly like /usr/java/jre1.5.0_11/bin/java. Its going to depend on where you installed it. |
| Extract CrushFTP folder ideally into /var/opt/ so it's an easier approach if you have issues finding it over time. |
| At line 19 changed one line |
| Starting CrushFTP |
| __Start / Stop CrushFTP__ |
| At line 21 changed one line |
| The key here is making sure you are in the CrushFTP directory (so its the working directory), and using the "-d" option to start in daemon mode. If you are not in the right directory when you start CrushFTP, it will start generating a new prefs.xml file and users folder from the new location where you started it. |
| There is a script provided to give you the basics of starting and stopping CrushFTP. It might be overkill for your situation, but you are welcome to use it and modify it for your needs. The script is crushftp_init.sh. Its included with your download of CrushFTP already. You must edit the script the first time you use it to set the correct path in it. |
| At line 23 changed one line |
| sudo java -jar CrushFTP.jar -d |
| {{{./crushftp_init.sh start |
| ./crushftp_init.sh stop}}} |
| At line 25 changed one line |
| You may also want to start it so it stays running even when you logout. |
| __Install / Uninstall CrushFTP__ |
| At line 27 changed one line |
| sudo nohup java -jar CrushFTP.jar -d& |
| There is a script provided to give you the automated process supported on most Linux distro's of installing and uninstalling CrushFTP. The script is crushftp_init.sh. |
| At line 29 changed one line |
| The "-?" option will list various command line options you can use: |
| {{{./crushftp_init.sh install |
| ./crushftp_init.sh uninstall}}} |
| At line 31 removed one line |
| java -jar CrushFTP.jar -? |
| At line 33 changed one line |
| Alternate Method |
| __Generating an Admin User__ |
| At line 35 changed one line |
| There is a script provided to give you the basics of starting and stopping CrushFTP. It might be overkill for your situation, but you are welcome to use it and modify it for your needs. The script is "crushftp_init.sh". Be sure to get the paths correct when using it. |
| While you technically can do everything with CrushFTP from the command line and editing text XML files, its much easier to use a web browser to do this. You just need to have an admin user created first. |
| At line 37 changed one line |
| Generating an Admin User |
| To make your user for doing this, use a command like this (avoid special characters in the comamnd line password creation): |
| At line 39 changed one line |
| While you technically can do everything with CrushFTP from the command line and editing text XML files, its much easier to use a GUI to do this. You can use remote administration with CrushFTP in order to remote control a headless server. This lets you have a full GUI controlling the headless linux installations of CrushFTP. |
| {{{ |
| java -jar CrushFTP.jar -a "crushadmin" "password" |
| }}} |
| or |
| {{{ |
| ./Java/bin/java -jar CrushFTP.jar -a "crushadmin" "password" |
| }}} |
| At line 41 removed one line |
| To make your user for doing this, use a command like this: java -jar CrushFTP.jar -a "username" "password" This will make a new user, and write it to the default location...users/lookup_21/username/. |
| At line 43 changed one line |
| You can then login using this username from a ftp client, or via the remote admin interface of CrushFTP. See my video on setting up a remote admin connection. The basics are opening CrushFTP, clicking manage servers button in the upper right. Add a new item, click on it and set the URL to match the credentials of the user you just made. Click apply, then click OK to close the manage servers window. Finally, select your server from the drop down and wait as CrushFTP connects to your server and gives you a remote admin interface to the GUI of the headless server. |
| This will make a new user, and write it to the default location: |
| At line 45 changed one line |
| Stopping CrushFTP |
| {{''users/MainUsers/crushadmin/''}} |
| At line 67 added 23 lines |
| You can now login to the administration console using a web browser. The default ports are: |
|
| {{{http://your_ip:8080/ |
| https://your_ip:443/}}} |
|
| [Install Video|http://www.crushftp.com/videos/linux_install.mp4] | [Quick Start Video|http://www.crushftp.com/videos/quick_start.mp4]\\ |
|
| __Alternate Start /Stop CrushFTP Methods__ |
|
| You may also want to start it so it stays running even when you logout. |
|
| {{{ |
| sudo nohup java -jar CrushFTP.jar -d& |
| }}} |
|
|
| The "-?" option will list various command line options you can use: |
|
| {{{ |
| java -jar CrushFTP.jar -? |
| }}} |
|
|
| At line 49 changed one line |
| You can also do it from a script. Let me explain. CrushFTP supports the "SITE QUIT" command if it has been enabled in the User Manager under the Admin tab for a user. So you can have a scripted command that simply logs into the server, issues SITE QUIT, then logs out. The server will then gracefully quit saving any unsaved data to disk before exiting. |
| You can also do it from a script. CrushFTP supports the "SITE QUIT" command if it has been enabled in the User Manager under the Admin tab for a user. So you can have a scripted command that simply logs into the server, issues SITE QUIT, then logs out. The server will then gracefully quit saving any unsaved data to disk before exiting. |
| At line 96 added one line |
| {{{ |
| At line 98 added one line |
| }}} |
| At line 102 added one line |
| {{{ |
| At line 58 changed 3 lines |
|
| quote user admin |
|
| quote user crushadmin |
| At line 62 removed one line |
|
| At line 64 removed one line |
|
| At line 108 added one line |
| }}} |
| At line 67 changed one line |
| Provided a user named "admin" exist, and they have permission to execute that command, CrushFTP will terminate once the user logs out. |
| Provided a user named "crushadmin" exist, and they have permission to execute that command, CrushFTP will terminate once the user logs out. |
| At line 69 changed one line |
| Generating a Password With CrushFTP from the Command Line |
| __Generating a Password With CrushFTP from the Command Line__ |
| At line 73 changed one line |
| java -jar CrushFTP.jar -p thePassword DES |
| {{{ |
| java -jar CrushFTP.jar -p DES thePassword |
| }}} |
| __Running as non-root (not recommanded)__ |
| \\ |
| \\ |
|
| This method details how to run from rc.local on a systemd init based Linux flavor. Running as a non-root user won't allow binding to ports below 1024, will need to use NAT or port rewrite rules in iptables to be able to server on IANA defined well known ports. |
|
| Running crush in user mode as "crushftp" system user, by adding below lines into rc.local (generic method) |
| {{{ |
| su - crushftp -c '/var/opt/CrushFTP10/crushftp_init.sh start' |
| exit 0 |
| }}} |
| \\ |
| This may be required in case daemon mode doesn't output to nohup.out, in this case modify the init script as |
| \\ |
| {{{ |
| $NOHUP $JAVA -Ddir=$CRUSH_DIR -Xmx384M -jar plugins/lib/CrushFTPJarProxy.jar -d 2>>nohup.out & |
|
| }}} |
| \\ |
| \\ |
| Running in user mode on systemd RHEL 7/8 family Linux |
| \\ |
| First in crushftp_init.sh will need to set the user as "crushftp" ( or whatever non-root user) then allow rc-local.service to be able to run ( needed for compatibility mode, non root user) |
| \\ |
| {{{ |
| touch /etc/systemd/system/rc-local.service |
| vi /etc/systemd/system/rc-local.service |
| }}} |
| \\ |
| paste into below |
| \\ |
| {{{ |
| [Unit] |
| Description=/etc/rc.local Compatibility |
| ConditionPathExists=/etc/rc.local |
|
| [Service] |
| Type=forking |
| ExecStart=/etc/rc.local start |
| TimeoutSec=0 |
| StandardOutput=tty |
| RemainAfterExit=yes |
| SysVStartPriority=99 |
|
| [Install] |
| WantedBy=multi-user.target |
|
| }}} |
| \\ |
|
| then edit /etc/rc.local |
| \\ |
| {{{ |
| vi /etc/rc.local |
| }}} |
| \\ |
| add in |
| \\ |
| {{{ |
| su crushftp /var/opt/CrushFTP10/crushftp_init.sh start |
| exit 0 |
| }}} |
| \\ |
| then make it executable |
| \\ |
| {{{ |
| chmod +x /etc/rc.local |
| }}} |
| \\ |
| then install the rc.local service |
| \\ |
| {{{ |
| systemctl enable rc-local.service |
| }}} |
| \\ |
| reboot, check if OK |
| \\ |
| \\ |
| \\ |
| Obsolete system V init method |
| \\ |
| \\ |
| create new scriptfile |
| \\ |
| {{{ |
| touch /etc/init.d/crushftp |
| }}} |
| \\ |
| add this script to /etc/init.d/crushftp |
| \\ |
| {{{ |
| #!/bin/bash |
| #!/bin/sh |
| # |
| # Control script for CrushFTP v1.4 running as crushuser |
| # |
| # chkconfig: - 86 14 |
| # description: CrushFTP |
| # |
| # BEGIN INIT INFO |
| # Provides: crushftp |
| # Required-Start: $local_fs |
| # Should-Start: $network |
| # Required-Stop: |
| # Should-Stop: $network |
| # Default-Start: 2 3 5 |
| # Default-Stop: 2 5 |
| # Short-Description: CrushFTP Server |
| # Description: Starts Crush on boot |
| # END INIT INFO |
|
| runuser crushuser -c "/var/opt/CrushFTP10/crushftp_init.sh $1" |
|
| ################################################################ |
| }}} |
| \\ |
| make it executable |
| \\ |
| {{{ |
| chmod 755 /etc/init.d/crushftp |
| }}} |
| \\ |
| install service |
| \\ |
| {{{ |
| chkconfig --add crushftp |
| chkconfig crushftp on |
| service crushftp start |
| }}} |
