feat: add install script with instructions

[ghost]

fixes #107

proposed changes

• Add an installation script
• Provide instructions on how to use the installation script
• Fix the manual installation instructions to be more general. This will allow us to change things without having to update the readme all the time.

[oupala]

In a first standard test, everything works like a charm. Good point!

I have to test it more deeply, but it looks good!

[oupala]

Here is what I had to change in the config file:

• in apaxy.config: INSTALL_DIRECTORY="/dev/apaxy-deploy"
• in apaxy.config: WEB_ROOT="/var/www/html"

Here are the changes after executing the script:

• in apaxy/theme/400.html: <link rel="stylesheet" href="/{FOLDERNAME}/theme/style.css" />
• in apaxy/theme/403.html: same as previous
• in apaxy/theme/404.html: same as previous
• in apaxy/theme/408.html: same as previous
• in apaxy/theme/500.html: same as previous
• in apaxy/theme/502.html: same as previous
• in apaxy/theme/footer.html: <script src=/{FOLDERNAME}/theme/apaxy.js></script>
• apaxy/theme/htaccess.txt renamed to apaxy/theme/.htaccess
• apaxy/htaccess.txt copied to .htaccess and all occurence of {FOLDERNAME} replaced

[oupala]

I did not test the "Copying files to web root..." feature as I don't want an unknown script to mess with my system. I think that this feature should be optional and disabled by default. It should be enabled using something like an --install flag.

[oupala]

It seems that the script is not idempotent and cannot be run twice without outputting an error. I think that line 27 return code should be checked.

cp -r . "$WEB_ROOT$INSTALL_DIRECTORY"

And maybe some other commands.

Additionnaly, it appears that the script tries to copy the .git directory, if apaxy has been cloned by git. The line 27 is - here again - copying to much things to the destination directory.

[oupala]

As far as I tested, the install feature works.

But I think this is a problem to link the configure feature with the install feature.

There is a bunch of usecases where you don't want to install apaxy, you juste want to configure it:

• when you want to configure apaxy, then you have to upload it to the server using ftp, sftp or ftps (when you don't have a console access on your mutualized web space)
• when you already have installed apaxy (ie. using a Dockerfile) and just want to configure it (configure the paths)

Moreover, the files used are named apaxy.config and apaxy-configure.sh. Hence their job is to configure apaxy, not to install it.

So, in my opinion we should split the two features. Either we have 2 scripts (apaxy-configure.sh and apaxy-install.sh) and one script can launch the other one (probably the install script should call the configure script). Either we keep the current script, but we add an option (which is false by default) to tell if we want to install apaxy or not after configuring it (--install true or --install false, where false is the default value whenever the parameter is not set on the command line).

What do you think of that @jordanbancino?

It could be good to close this merge request in a near futur so that we can fix the Dockerfile issue (#115) by using this configure script in the Docker image build.

[ghost]

Yep, I completely agree with everything you’ve said here. I am so sorry, but I just simply don’t have the time to help out with this project. Maybe over the summer I can take a look again and fix it up. Just not now, or any time soon, I have a lot going on. I do appreciate being mentioned in these, so I can keep up with the project though. I definitely think the changes you’re proposing are important and should be looked at, though.

[oupala]

If I understand well, I can try to fix it myself. But if I don't, you might do that in a few months.

Am I right?

[ghost]

Yes, that sounds good. I would love to help out, and maybe I can do something every once and a while, there’s just a lot going on for me that I need to figure out first. Summer is the best time for me to get stuff done, though with work and college and stuff, it may be hard.

[oupala]

Could you please add me to your apaxy repo so that I can add content to your pull request?

Otherwise I can start a new pull request or branch, but all the useful comments from this pull request will miss us.

[ghost]

Yep, no problem, I just did. 👍 My schedule should be clearing up just a tad here soon so I may be able to help, but no guarantees yet.

[oupala]

I have largely rewrote the install process and I have tester many usecases:

• apaxy installed at the webroot
• apaxy installed somewhere deeper in another directory

Could you please tell me if you have time to test it a bit before I merge the pull request?

[oupala]

It seems that you don't time to test this pull request at this moment. I'll merge this pull request as I have other works that depend on this install script.

Feel free to test it later and to open issues if you find any problem.