Configuration

All bellow configurations are optional. Appskull must work without any of these configurations.

Set encryption key

A encryption key is a piece of information that controls the cryptographic process and permits an encrypted string to be decoded. In fact, the key you chose will provide the only means to decode data that was encrypted with that key, so not only must you choose the key carefully, you must never change it if you intend use it for persistent data.

It goes without saying that you should guard your key carefully. Should someone gain access to your key, the data will be easily decoded. If your server is not totally under your control it’s impossible to ensure key security so you may want to think carefully before using it for anything that requires high security, like storing credit card numbers.

  1. Get your encryption key.

    Go to Nudasoft encryption key generator and copy your encryption key.

  2. Set your encryption key.

    The encryption key can be configured in [app_root]/app/config/config.php file. Just open this file and locate $config['encryption_key'] configuration option and replace default encryption key with the new one.

    For example, $config['encryption_key'] = hex2bin('56913ccba1da51a9c733acd00135cff839f156e3b42bee0d5b67e929d83cec4c');.

Removing the index.php file in URLs

By default, the index.php file will be included in all URLs. For example, http://example.com/index.php/users. But if you need to get URLs without the index.php part like this http://example.com/users. It can be done very easily.

  1. Apache server mod_rewrite module required. (Not applicable for Nginx web server)

    Apache server mod_rewrite module should be enabled. If this module was disabled, then you may have to restart the Apache server in order to take the effect.

  2. Set index_page configuration to empty.

    Open [app_root]/app/config/config.php configuration file and locate $config['index_page'] configuration option. Then set it to empty string of characters.

    For example, $config['index_page'] = '';.

  3. Create a .htaccess file. (Not applicable for Nginx web server)

    By default Appskull comes with a .htaccess.txt file in the root of the Appskull directory. This file won't work since it's a .txt file. But you can create a .htaccess file very easily from this file. Check bellow animated image.

    Create a .htaccess file

    After you create a .htaccess file, you can delete or keep the .htaccess.txt file.

  4. Activate and set RewriteBase rule in .htaccess file. (Not applicable for Nginx web server)

    By default RewriteBase rule in .htaccess file is commented out (Disabled). But you can active it by simple removing the # character in front of the RewriteBase rule. Check bellow animated image.

    Activate RewriteBase rule in .htaccess file

    Before you activate RewriteBase rule or do any kind of modifications to the .htaccess file, please check bellow instructions. Because in some situations you don't have to do any modifications to the .htaccess file.

    1. If Appskull hosted in a root of the host. For example, http://example.com, http://www.example.com, http://localhost. Then you don't have to do any modifications to the .htaccess file.

    2. If Appskull hosted in a sub directory of the host. For example, http://example.com/appskull, http://localhost/appskull. Then you have to activate RewriteBase rule and set it. When setting the RewriteBase rule, always exclude the host part from the base URL.

      Examples:

      • Base url http://localhost/appskull/. It's RewriteBase rule should be RewriteBase /appskull/.
      • Base url http://localhost/apps/appskull/. It's RewriteBase rule should be RewriteBase /apps/appskull/.
      • Base url http://example.com/appskull/. It's RewriteBase rule should be RewriteBase /appskull/.
      • Base url http://example.com/apps/appskull/. It's RewriteBase rule should be RewriteBase /apps/appskull/.
      • Base url http://www.example.com/apps/appskull/. It's RewriteBase rule should be RewriteBase /apps/appskull/.

Set URL suffix

In [app_root]/app/config/config.php configuration file you can specify a URL suffix that will be added to all URLs generated by Appskull. For example, http://example.com/users.html. To set this configuration, locate the $config['url_suffix'] configuration option and set URL suffix.

Examples:

  • $config['url_suffix'] = ''; to URLs like http://example.com/users.
  • $config['url_suffix'] = '/'; to URLs like http://example.com/users/.
  • $config['url_suffix'] = '.html'; to URLs like http://example.com/users.html.
  • $config['url_suffix'] = '.asp'; to URLs like http://example.com/users.asp.
  • $config['url_suffix'] = '.hello'; to URLs like http://example.com/users.hello.

Email configurations

By default Appskull use PHP's built-in mail method to send emails. So most of the time email sending should work fine. If you want to configure email configurations, that can be done in the [app_root]/app/config/email.php configuration file.

You can get all available email configurations from this URL: https://www.codeigniter.com/user_guide/libraries/email.html#email-preferences.

As a example you can find more information about how to use SendGrid third party email sender in Appskull from this link: https://sendgrid.com/docs/for-developers/sending-email/codeigniter/

Also you can change the default email sending email address on the Appskull system settings -> app module page.

Change default email sending email address

Pagination configurations

Pagination configurations can be set in [app_root]/app/config/pagination.php configuration file. There are many configuration options available. But most of the time you only need to change one or two configurations. For example, $config['per_page'], $config['num_links'].

  • $config['per_page']

    The number of items you intend to show per page in all CRUD views.

    Pagination per_page configuration
  • $config['num_links']

    The number of "digit" links you would like before and after the selected page number. For example, the number 2 will place two digits on either side.

    Pagination number of digits before and after selected number

    You can get more information about pagination and other pagination related configurations from this URL: https://codeigniter.com/user_guide/libraries/pagination.html.

Set default timezone

By default Appskull timezone set to America/Adak. But you can change it in the config.php file that sitting under [app_root]/app/config/modules/app directory. After you open that configuration file, locate $config['app_timezone'] configuration option and set your desired timezone.

You can find list of supported timezones via this URL: http://php.net/manual/en/timezones.php

Copyright © Nudasoft.