Documenting the NAS box and related setup procedures

[hamishmb]

So I decided to make a start on this today.

I think I'll start by documenting:

• Restoring system settings using the backup file we have on the webserver.
• Installing phpmyAdmin with D-Link's official package.
• Upgrading this to the latest version that can be run on the box to improve security.
• Hacking the start-up scripts on the NAS box, so we can load our custom start-up scripts.
• Deploying our custom start-up scripts and sysroot to the NAS box.

Seems like a good time to do it, and I have the box so I can take screenshots and similar to hopefully make it easy to follow, though using the commandline and SSH will be required.

Terry, perhaps you could start on:

• Documenting how to build the cross compiler (thread at viewtopic.php?f=36&t=157)
• ^ Note that we have the VM available for download, but having the original instructions for creating it would be useful too.
• The process of adding public SSH keys to the NAS box (https://www.ssh.com/ssh/keygen/) (I'll need to modify this slightly due to weird file locations in our custom setup, but my changes would be minor, so would still be useful for you to do )

The cross compiler is quite complicated, which means it might take you a little while, but I thought it'd be good for you to document that because then if anything is unclear we can rectify it and make it more accessible.

There's going to be a lot of other stuff to document, but this would be a good start I think

[TerryJC]

Hamish,

I'll start this later today or tomorrow; I have a few things I'd like to get sorted first.

[hamishmb]

Okay

[TerryJC]

BTW. I think we should both use the same document as a starting point, so once you've decided which one to pick, let me know and I use it too.

This will make it easier to merge the different sections.

[hamishmb]

Sounds good.

I was thinking I'd just start with our existing installation spec at https://wmtprojectsforum.altervista.org ... stallation and add some sections to it under 4.4 for the NAS box. Does that sound okay?

[TerryJC]

Yes. As long as we both use the same one.

[hamishmb]

Okay. I suggest we make section 4.4.3 the NAS box section, and bump all the others down. I don't know how to edit the table of contents, so I'll have to leave that bit to you.

[TerryJC]

You don't edit the ToC; you simply complete your edits, right-click it and select 'Update'.

[hamishmb]

Okay

[TerryJC]

I was thinking I'd just start with our existing installation spec at https://wmtprojectsforum.altervista.org ... stallation and add some sections to it under 4.4 for the NAS box. Does that sound okay?

I've just had a look at that statement and I think that we were talking at cross purposes. I had assumed that your intention was to create a new document called 'Installation Specification: NAS Box' and you have assumed that we would simply add the data to Section 4.4 of the existing Spec, eg 'Section 4.4.6 - NAS Box Configuration'. Is that right? If so, then I believe that we should both begin by creating brand new documents based on the existing Installation Spec and then one of us should meld the new material into Version 0.9 of the Spec. (I suggest that you retain the original material, so that the heading numbering matches up and I will add dummy headings to my version to ensure that my headings follow on from the ones that you are using.)

If the latter, then it makes sense, although the heading depth may end up being a bit excessive. However, with careful structuring of the document eg:

4.4.6.1 - Restoring system settings using the backup file we have on the webserver.
4.4.6.2 - Installing phpmyAdmin with D-Link's official package.
4.4.6.3 - Upgrading this to the latest version that can be run on the box to improve security.
4.4.6.4 - Hacking the start-up scripts on the NAS box, so we can load our custom start-up scripts.
4.4.6.5 - Deploying our custom start-up scripts and sysroot to the NAS box.
4.4.6.6 - How to Build the Cross-compiler.
4.4.6.7 - Adding SSH Keys.

Each of those sub-heading may have to go to five or six levels deep to cover the different aspects of the subject, especially with the Cross-compiler.

What do you think?