Show Posts
This section allows you to view all posts made by this member. Note that you can only see posts made in areas you currently have access to.
Messages - Norodo
121
Documentation / Database continued
« on July 2nd, 2012, 08:15 AM »
Database settings
At this point in the install you are asked to enter your database settings. You should have already gone through the basic database setup before you do this part.
At this point in the install you are asked to enter your database settings. You should have already gone through the basic database setup before you do this part.
- Server name: As the installer will tell you, it is usually Localhost. It is not always localhost though. If you have phpMyAdmin installed you can find your server name there.
 |
- Username: This should be the same as the user name you used in the database setup, or the user name your host has given you.
- Password: This should also be the same as the user name you used in the database setup, or the password your host has given you.
- Database name: This should be the same as the database name you used in the database setup.
- Table prefix: If you only plan on installing one Wedge board on this database, simply leave it as is. If you plan on installing several boards on the same database, choose something unique for both of them.
122
Documentation / SSI.php
« on June 29th, 2012, 02:32 PM »
SSI.php is a common way of weaving forum data into a non-forum webpage. For instance, you can list recent topics in the sidebar of your homepage.
How to use SSI.php
So far, SSI.php is pretty much the same in Wedge as in SMF, so you can usually refer to the SMF documentation
How to use SSI.php
So far, SSI.php is pretty much the same in Wedge as in SMF, so you can usually refer to the SMF documentation
123
Documentation / Permissions
« on June 29th, 2012, 02:20 PM »
Setting file permissions
In order for PHP / Wedge to be allowed to change and use files, you might have to change the file permissions. [1]
This can be done in many ways.
The “required” permission level can vary from program to program, but it is usually adviceable to set your permissions to be liberal while installing, and secure while running. While installing you should set files that need to be used[2] to 777 (all permissions), while on a running system you will want your files to have the permissions set to 644. If that doesn't work for you, try 664.
Using your SFTP client
You can usually change the file permissons with your SFTP client. As an example, in WinSCP, you can right click a file or a folder, and even choose if you want the permissions to recurse down the folder hierarchy. Don't forget to set the files back to 644 or 664 when you are done with the installation.
Using SSH / console
You can also, of course, use the local console or SSH if you prefer that. Usage is pretty simple, first you cd to the directory where wedge is located, then you use the chmod command to change the files you need changed to the setting you want them to be at. IE: If Wedge asks you to change the files called configuration.txt and data/config.cfg to be writable you can type chmod 777 configuration.txt data/config.cfg. Don't forget to set the files back to 644 or 664 when you are done with the installation.
In order for PHP / Wedge to be allowed to change and use files, you might have to change the file permissions. [1]
This can be done in many ways.
The “required” permission level can vary from program to program, but it is usually adviceable to set your permissions to be liberal while installing, and secure while running. While installing you should set files that need to be used[2] to 777 (all permissions), while on a running system you will want your files to have the permissions set to 644. If that doesn't work for you, try 664.
Using your SFTP client
You can usually change the file permissons with your SFTP client. As an example, in WinSCP, you can right click a file or a folder, and even choose if you want the permissions to recurse down the folder hierarchy. Don't forget to set the files back to 644 or 664 when you are done with the installation.
Using SSH / console
You can also, of course, use the local console or SSH if you prefer that. Usage is pretty simple, first you cd to the directory where wedge is located, then you use the chmod command to change the files you need changed to the setting you want them to be at. IE: If Wedge asks you to change the files called configuration.txt and data/config.cfg to be writable you can type chmod 777 configuration.txt data/config.cfg. Don't forget to set the files back to 644 or 664 when you are done with the installation.
| 1. | Usually you will have to. |
| 2. | But only the files that need to be used, not all files. |
124
Documentation / Database
« on June 29th, 2012, 10:26 AM »
Setting up the database for Wedge
Wedge is sometimes able to create and configure the database and settings for you during install, but it is almost always preferable to set up the database and settings yourself using phpMyAdmin or the mysql command line, due to security concerns, and because the PHP installation doesn't always have enough permissions to create a database.
Setting up the database for Wedge using phpMyAdmin
Creating a database
The first thing you want to do in phpMyAdmin is create a database that Wedge can use to store data.
You can run Wedge using your root / superadmin user, but this is not a good idea. Quickly summarized you are much more likely to destroy something unintentionally if you let Wedge use your root account It is generally recommended to run Wedge as a limited user. [1]
First, connect to the MySQL from SSH or Console like this: mysql –user=myusername –password –host=localhost –port=3306 . Replace myusername with the actual mysql username that Wedge will use to access the MySQL database. [2] You will immediately be prompted to “Enter password”. Type in the password for the above mysql user. Hit enter, if all goes well, you should see a welcome message similar to this:
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 1238
Server version: 5.1.58-1ubuntu1 (Ubuntu)
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.
This software comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to modify and redistribute it under the GPL v2 license
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
You will noe be creating a database that Wedge will use. In the mysql commandline interpreter, simply run this statement:
Code: [Select]
Then hit enter. If all goes well, the result of your query should read:
Query OK, 1 row affected (0.00 sec)
Type exit to leave mysql's commandline interpreter and continue your install
Wedge is sometimes able to create and configure the database and settings for you during install, but it is almost always preferable to set up the database and settings yourself using phpMyAdmin or the mysql command line, due to security concerns, and because the PHP installation doesn't always have enough permissions to create a database.
Setting up the database for Wedge using phpMyAdmin
Creating a database
The first thing you want to do in phpMyAdmin is create a database that Wedge can use to store data.
- Open phpMyAdmin
- Press databases
- At the bottom where it says “Create new database”, enter a name for your database. I recommend you choose a short but descriptive name. If your community name is “Le Wino” you can call the database “wino_wedge” or something like that.
- Check “databases” to see if “wino_wedge” has indeed been created.
You can run Wedge using your root / superadmin user, but this is not a good idea. Quickly summarized you are much more likely to destroy something unintentionally if you let Wedge use your root account It is generally recommended to run Wedge as a limited user. [1]
- First, click your way into your Wedge database.
- Click “Privileges”
- Add a new user
- Enter your new user information. Leave host as “Any host” unless you know what you are doing.
- Grant all privileges on your Wedge database
- Uncheck all global privileges
- Remember your user information and use this in the install.php part of the installation process.
- Continue the installation
First, connect to the MySQL from SSH or Console like this: mysql –user=myusername –password –host=localhost –port=3306 . Replace myusername with the actual mysql username that Wedge will use to access the MySQL database. [2] You will immediately be prompted to “Enter password”. Type in the password for the above mysql user. Hit enter, if all goes well, you should see a welcome message similar to this:
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 1238
Server version: 5.1.58-1ubuntu1 (Ubuntu)
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.
This software comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to modify and redistribute it under the GPL v2 license
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
You will noe be creating a database that Wedge will use. In the mysql commandline interpreter, simply run this statement:
CREATE DATABASE myexampledatabaseName
DEFAULT CHARACTER SET utf8
DEFAULT COLLATE utf8_general_ci; Then hit enter. If all goes well, the result of your query should read:
Query OK, 1 row affected (0.00 sec)
Type exit to leave mysql's commandline interpreter and continue your install
| 1. | This is not to say that Wedge will ruin your webserver, but this simple step can help you from making changes to the wrong databases, and increase the security from “hackers" |
| 2. | For more information on creating a user, see CREATE USER |
125
Documentation / Uploading
« on June 29th, 2012, 10:12 AM »
Uploading
There are several ways to get a Wedge loaded onto your server. Novice users should use the SFTP method.
SFTP
There are several ways to get a Wedge loaded onto your server. Novice users should use the SFTP method.
SFTP
- Download the latest Wedge package
- Unpack it in a directory.
- Move install.php, install.sql, Settings.php and Settings.php.bak to the "root" folder from the install folder. This folder will typically be called wedge-master
- Upload the files to your server using SFTP. WinSCP is a decent free SFTP client.
- Continue the install.
- Log on to your SSH / console.
- cd to the folder you want to install Wedge to.
- Type wget https://github.com/Wedge/wedge/archive/master.zip
- Unpack the files using either unzip filename or tar -xf filename depending on the file type[3]
- Ensure the Wedge files are in the directory you want to run them from.
- Move install.php, install.sql, Settings.php and Settings.php.bak to the "root" folder.
- Continue your install.
| 1. | This is a guide for somewhat more advanced users |
| 2. | This method seems slower, but is actually faster because you don't have to download the files to your computer and then upload them one by one by slow FTP. For this one you are going to need to have some basic Linux file system knowledge. |
| 3. | .zip files are unzipped. tar.gz, tar.bz, tar.xz, tgz, tbz and txz files are tar -xfed |
126
Documentation / Restoring backups
« on June 28th, 2012, 07:48 PM »
Restoring backups
If you have a small database you can use phpMyAdmin to restore your backup.[1]
Restoring backups with phpmyadmin
Alternatives
If your backup size is too large for your PHP settings, you might have to restore your backup from SSH or command line. To do so, you upload the backup database file to your host, then runCode: [Select] where user is the database user you created for Wedge when you installed or root. Password is the password for that user (there's no space between -p and the password!) database_name is the database you use for Wedge and dumpfilename.sql is the name and location for the sql or sql.bz(x) file you have uploaded. (Ie /home/bob/backup.sql)
See also
Taking backups
If you have a small database you can use phpMyAdmin to restore your backup.[1]
Restoring backups with phpmyadmin
- Open phpMyAdmin[2]
- Click “databases”, then click “import”.
- Find your file. You can also see the max size you can upload here.
- Press go.
Alternatives
If your backup size is too large for your PHP settings, you might have to restore your backup from SSH or command line. To do so, you upload the backup database file to your host, then run
mysql -u user -ppassword database_name < dumpfilename.sql See also
Taking backups
| 1. | The maximum size phpmyadmin can usually handle is around 8MB |
| 2. | If you don't know if you have phpmyadmin, ask your provider. phpmyadmin can sometimes be accessed from an admin panel on your webhost, or on yoursite.com/phpmyadmin |
128
Documentation / Using Wedge [WIP]
« on June 28th, 2012, 07:46 PM »
This section is marked as “for users” but as you and I know, users will never read a manual like this unless they are in some way odd. Therefore, this section will contain information that might be an idea to include in a “FAQ” post at your forum or something like that.
BBcode
Note: This section is very likely to change rapidly while Wedge is still in its infancy.
What is BBCode?
BBCode is a way to mark up your text in a forum in order to make it bold, italic or even make it a link.
It seems Wedge will use BBCode for text formatting, but the exact tags that will be supported is a matter to change (we don't even know if Wedge will use BBCode yet.) For now you can read up a bit on BBCodes over at SMF.
Wedge specific BBCodes
These are some codes that are not in SMF core but exist in Wedge:
BBcode
Note: This section is very likely to change rapidly while Wedge is still in its infancy.
What is BBCode?
BBCode is a way to mark up your text in a forum in order to make it bold, italic or even make it a link.
It seems Wedge will use BBCode for text formatting, but the exact tags that will be supported is a matter to change (we don't even know if Wedge will use BBCode yet.) For now you can read up a bit on BBCodes over at SMF.
Wedge specific BBCodes
These are some codes that are not in SMF core but exist in Wedge:
| Tag | Effect | Usage |
| nb | Inserts a footnote | [nb]footnote[/nb] |
| spoiler | Inserts text that is not readable before a button is clicked | [spoiler]Darth Vader: No. I am your father.[/spoiler] |
129
Documentation / WeCSS [WIP] [Definitely needs Naos steady hand]
« on June 28th, 2012, 07:45 PM »
Note: WeCSS is the CSS parser in Wedge. This page will, when completed, contain information on how WeCSS works. For now it will contain what I know.
WeCSS basics
Something about no semicolons and variables [tbc]
How WeCSS looks
Code: [Select]
Using "regular" CSS
You can use regular CSS on a filewide basis, which means you can not mix WeCSS-style CSS and regular CSS, and you may not use regular CSS in the main files. If you want to use both kinds of CSS, put them in different files. [probably need to answer why.]
WeCSS basics
Something about no semicolons and variables [tbc]
How WeCSS looks
.catbase
overflow: hidden
border-radius: 5px
padding: 5px 10px 5pxUsing "regular" CSS
You can use regular CSS on a filewide basis, which means you can not mix WeCSS-style CSS and regular CSS, and you may not use regular CSS in the main files. If you want to use both kinds of CSS, put them in different files. [probably need to answer why.]
130
Documentation / Authoring a site theme [WIP] [Needs Naos steady hand]
« on June 28th, 2012, 07:44 PM »
Determining the scope of your project
Needs and goals when modifying messageboards can vary a lot. Some of us simply want to edit the background color of posts, while some of us want to redesign our pages from the bottom up to give them that “unique” feel. Wedge fortunately makes it relatively simple to do either.
If you want to change how the whole site feels and behaves, you want to create a theme. If you want to make a quick change to Wedge, like changing the colour of post content, you want to create a skin. A skin slides over its theme to change only a few properties of it.
Theme
To make a theme, make a subfolder […tbc…]
Skin
Needs and goals when modifying messageboards can vary a lot. Some of us simply want to edit the background color of posts, while some of us want to redesign our pages from the bottom up to give them that “unique” feel. Wedge fortunately makes it relatively simple to do either.
If you want to change how the whole site feels and behaves, you want to create a theme. If you want to make a quick change to Wedge, like changing the colour of post content, you want to create a skin. A skin slides over its theme to change only a few properties of it.
Theme
To make a theme, make a subfolder […tbc…]
Skin
- To make a skin, make a subfolder in the skins folder. The skins folder will by default be in /var/www/wedge/Themes/, but this can vary depending on your service provider. It will at least be in the Themes subfolder of your Wedge installation. [1][2]
- The next step is to fill in the information for your skin so Wedge can know the basics of what it's dealing with. An easy way to do this is to copy the skin.xml file from the Wuthering skin folder to your skin folder and editing the contents of it. A deeper description of the skin.xml file can be found in the ~Warm/skin.xml file
- CSS [tbc]
| 1. | The folder can have any name you want, but I would recommend you name it either the same as your skin, or the shortened name of your skin. For example: For a skin called The Undertaker, you can name the folder Undertaker. |
| 2. | Protip: You can also create subskins by creating new skin folders inside the already existing skin folders. For example, you can edit the Warm skin by creating a folder inside the Warm folder |
131
Documentation / Backups
« on June 28th, 2012, 07:42 PM »
Introduction
As you already know, taking backups of your content is important. [1]
Backing up forum data
In order to back up your userbase, threads and posts, you are going to have to copy your database. There are several ways to do this, but the easiest way is by using phpmyadmin[2]
Using phpmyadmin to take a database backup
Using SSH / the command line
Making backups using the command line or SSH is of course also possible. This is generally done with the mysqldump command like this:Code: [Select] Where user is the Wedge database user or root. Password is this users password (note that there is no space between -p and the password), database_name is the database name you used for Wedge and dumpfilename.sql is the name and location of the backup file (ie: /home/bob/backup.sql). Your backup file is now available in that location. To conserve bandwidth you might want to compress the file. For simplicity and compatibility we recommend you use bzip or gzip compression, as these can be imported via phpmyadmin easily as long as they're under 8MB or your PHP max limit.
Backing up settings and themes
In order to back up most of your settings, themes and add-ons, you simply have to backup your forum files using FTP or another remote file administration program.
See also
Restoring backups
Automated backups
As you already know, taking backups of your content is important. [1]
Backing up forum data
In order to back up your userbase, threads and posts, you are going to have to copy your database. There are several ways to do this, but the easiest way is by using phpmyadmin[2]
Using phpmyadmin to take a database backup
- Log on to your phpmyadmin page. It is usually found at mysite.com/phpmyadmin or in an admin panel at your host.
- Click your way into “databases” and find the one you instructed Wedge to install to. Click it.
- Press export
- Make sure all the tables are selected. You can do this by pressing “select all”. Ensure that you've got SQL marked as the desired output.
- At the bottom, turn on bzip compression. This will severely shrink (75-80%~) the size of the backup, which can get fairly huge with larger forums.
- Click “Go”
- Make a nice cup of tea and wait for your file to be downloaded.
Using SSH / the command line
Making backups using the command line or SSH is of course also possible. This is generally done with the mysqldump command like this:
mysqldump -u user -ppassword database_name > dumpfilename.sqlBacking up settings and themes
In order to back up most of your settings, themes and add-ons, you simply have to backup your forum files using FTP or another remote file administration program.
See also
Restoring backups
Automated backups
| 1. | And if you don't know now, you will know when your data gets lost or corrupted someday. |
| 2. | If you don't know if you have phpmyadmin, ask your provider. phpmyadmin can sometimes be accessed from an admin panel on your webhost, or on yoursite.com/phpmyadmin. |
132
Documentation / Installing Wedge
« on June 28th, 2012, 07:41 PM »
Pre-preparation
Installation
After install
- Before you start the installation, make sure your server fulfills the requirements
- Get the latest Wedge package and unpack it on your server in a web accessible folder. [1]
- Create a database and a “semi-privileged” user. [2]
Installation
- Point your web browser to yourserver.com/path_to_wedge/install.php and follow the instructions. The first hinder you'll meet is likely to be setting up file permissions.[3]
- Next up you will have to enter some information about the database you set up in step 3 of the initial setup. [4]
- After this, simply follow the instructions and you should end up with a functioning forum.
After install
- At this point you may want to remove anything superfluous like the Wedge installation files.
- At last you should start configuring Wedge to function like you want.
| 1. | There are several ways to do this. For more help, see Uploading. |
| 2. | See database for more information on this. |
| 3. | See permissions for more information on this. |
| 4. | See database continued for more information on this. |
133
Documentation / Style guidelines [Very WIP]
« on June 28th, 2012, 07:13 PM »
WIP
Don't add a top level header
Formatting:
Header (Defined in "subject")
[Introduction]
Subheader - 14pt bold
[Body text]
[Sub-subheader - bold]
[Body text]
Don't add a top level header
Formatting:
Header (Defined in "subject")
[Introduction]
Subheader - 14pt bold
[Body text]
[Sub-subheader - bold]
[Body text]
134
Documentation / Requirements
« on June 28th, 2012, 07:12 PM »
Server side
A HTTP server
Apache or an "Apache compliant" server like lighttpd is recommended. Wedge will also run on ISS.
PHP 5.2
PHP 5.2 or higher.
MySQL 5.1
MySQL 5.1 or higher.
GD2 for PHP.
GD is a graphics library used to output graphics from PHP, and will be a requirement in Wedge.
Client side
A modern browser
Opera 9.0 or higher, 11.x or higher recommended.
Microsoft Internet Explorer 6.0 or higher, 9.0 or higher recommended.
Mozilla Firefox 2.0 or higher, 3.5 or higher recommended.
Apple Safari 3.0 or higher, 5.0 or higher recommended.
Google Chrome 1.0 or higher, 5.0 or higher recommended.</code>
Other
Recommended:
Cookies
Flash (mostly for playing videos)
Javascript (Wedge can be run without JS, but it will be less smooth)
A HTTP server
Apache or an "Apache compliant" server like lighttpd is recommended. Wedge will also run on ISS.
PHP 5.2
PHP 5.2 or higher.
MySQL 5.1
MySQL 5.1 or higher.
GD2 for PHP.
GD is a graphics library used to output graphics from PHP, and will be a requirement in Wedge.
Client side
A modern browser
Opera 9.0 or higher, 11.x or higher recommended.
Microsoft Internet Explorer 6.0 or higher, 9.0 or higher recommended.
Mozilla Firefox 2.0 or higher, 3.5 or higher recommended.
Apple Safari 3.0 or higher, 5.0 or higher recommended.
Google Chrome 1.0 or higher, 5.0 or higher recommended.</code>
Other
Recommended:
Cookies
Flash (mostly for playing videos)
Javascript (Wedge can be run without JS, but it will be less smooth)
135
The Pub / [FAQ] Re: Is it a friendly fork?
« on June 27th, 2012, 12:56 PM »
I'm one of those people who go through phases of WOHOO, LET'S TEST AND WORK and then suddenly I feel less inclined to do so and more inclined to rewatch the third season of The Simpsons. What I can say is that when I apply to do something I never do so just to get access to the code, and even less so in the case of Wedge, where one can't really reliably use it before a public release is made anyway (which is why I don't see why people would even really want to get their hands on the code just to get their hands on the code). It'd just be too much work to follow updates and changes to the database and all that jazz.
On that note I should probably check over the Wiki again, see if there's anything I miss there. What better time to do so than at a desk at a job with little to do.
On that note I should probably check over the Wiki again, see if there's anything I miss there. What better time to do so than at a desk at a job with little to do.