github.com/bosssauce/ponzu@v0.11.1-0.20200102001432-9bc41b703131/docs/build/System-Configuration/Settings/index.html (about) 1 2 <!DOCTYPE html> 3 <html lang="en" class="no-js"> 4 <head> 5 6 <meta charset="utf-8"> 7 <meta name="viewport" content="width=device-width,initial-scale=1"> 8 9 10 11 12 <link rel="shortcut icon" href="../../assets/images/favicon.png"> 13 14 <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.6.1"> 15 16 17 18 <title>Configuring Your Ponzu System Settings</title> 19 20 21 22 <script src="../../assets/javascripts/modernizr-56ade86843.js"></script> 23 24 25 <link rel="stylesheet" href="../../assets/stylesheets/application-4d0d3f2fbf.css"> 26 27 <link rel="stylesheet" href="../../assets/stylesheets/application-f78e5cb881.palette.css"> 28 29 30 31 32 33 34 35 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono"> 36 <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> 37 38 <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"> 39 40 41 42 </head> 43 44 45 46 47 <body data-md-color-primary="grey" data-md-color-accent="light-blue"> 48 49 <svg class="md-svg"> 50 <defs> 51 52 53 <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> 54 55 </defs> 56 </svg> 57 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer"> 58 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="search"> 59 <label class="md-overlay" data-md-component="overlay" for="drawer"></label> 60 61 <header class="md-header" data-md-component="header"> 62 <nav class="md-header-nav md-grid"> 63 <div class="md-flex"> 64 <div class="md-flex__cell md-flex__cell--shrink"> 65 66 <a href="../.." title="Ponzu" class="md-logo md-header-nav__button"> 67 <img src="../../images/logo.png" width="24" height="24"> 68 </a> 69 70 </div> 71 <div class="md-flex__cell md-flex__cell--shrink"> 72 <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label> 73 </div> 74 <div class="md-flex__cell md-flex__cell--stretch"> 75 <span class="md-flex__ellipsis md-header-nav__title"> 76 77 78 79 <span class="md-header-nav__parent"> 80 System Configuration 81 </span> 82 83 84 Settings 85 86 </span> 87 </div> 88 <div class="md-flex__cell md-flex__cell--shrink"> 89 90 <label class="md-icon md-icon--search md-header-nav__button" for="search"></label> 91 92 <div class="md-search" data-md-component="search"> 93 <label class="md-search__overlay" for="search"></label> 94 <div class="md-search__inner"> 95 <form class="md-search__form" name="search"> 96 <input type="text" class="md-search__input" name="query" required placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query"> 97 <label class="md-icon md-search__icon" for="search"></label> 98 <button type="reset" class="md-icon md-search__icon" data-md-component="reset">close</button> 99 </form> 100 <div class="md-search__output"> 101 <div class="md-search__scrollwrap" data-md-scrollfix> 102 <div class="md-search-result" data-md-component="result"> 103 <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents"> 104 Type to start searching 105 </div> 106 <ol class="md-search-result__list"></ol> 107 </div> 108 </div> 109 </div> 110 </div> 111 </div> 112 113 </div> 114 <div class="md-flex__cell md-flex__cell--shrink"> 115 <div class="md-header-nav__source"> 116 117 118 119 120 121 122 123 <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> 124 125 <div class="md-source__icon"> 126 <svg viewBox="0 0 24 24" width="24" height="24"> 127 <use xlink:href="#github" width="24" height="24"></use> 128 </svg> 129 </div> 130 131 <div class="md-source__repository"> 132 ponzu-cms/ponzu 133 </div> 134 </a> 135 136 137 </div> 138 </div> 139 </div> 140 </nav> 141 </header> 142 143 <div class="md-container"> 144 145 146 <main class="md-main"> 147 <div class="md-main__inner md-grid" data-md-component="container"> 148 149 150 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> 151 <div class="md-sidebar__scrollwrap"> 152 <div class="md-sidebar__inner"> 153 <nav class="md-nav md-nav--primary" data-md-level="0"> 154 <label class="md-nav__title md-nav__title--site" for="drawer"> 155 156 <i class="md-logo md-nav__button"> 157 <img src="../../images/logo.png"> 158 </i> 159 160 Ponzu 161 </label> 162 163 <div class="md-nav__source"> 164 165 166 167 168 169 170 <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> 171 172 <div class="md-source__icon"> 173 <svg viewBox="0 0 24 24" width="24" height="24"> 174 <use xlink:href="#github" width="24" height="24"></use> 175 </svg> 176 </div> 177 178 <div class="md-source__repository"> 179 ponzu-cms/ponzu 180 </div> 181 </a> 182 183 </div> 184 185 <ul class="md-nav__list" data-md-scrollfix> 186 187 188 189 190 191 192 <li class="md-nav__item"> 193 <a href="../.." title="Home" class="md-nav__link"> 194 Home 195 </a> 196 </li> 197 198 199 200 201 202 203 204 <li class="md-nav__item md-nav__item--nested"> 205 206 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2"> 207 208 <label class="md-nav__link" for="nav-2"> 209 CLI 210 </label> 211 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 212 <label class="md-nav__title" for="nav-2"> 213 CLI 214 </label> 215 <ul class="md-nav__list" data-md-scrollfix> 216 217 218 219 220 221 222 223 <li class="md-nav__item"> 224 <a href="../../CLI/General-Usage/" title="General Usage" class="md-nav__link"> 225 General Usage 226 </a> 227 </li> 228 229 230 231 232 233 234 235 <li class="md-nav__item"> 236 <a href="../../CLI/Generating-References/" title="Generating References" class="md-nav__link"> 237 Generating References 238 </a> 239 </li> 240 241 242 </ul> 243 </nav> 244 </li> 245 246 247 248 249 250 251 252 <li class="md-nav__item md-nav__item--nested"> 253 254 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> 255 256 <label class="md-nav__link" for="nav-3"> 257 Content 258 </label> 259 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 260 <label class="md-nav__title" for="nav-3"> 261 Content 262 </label> 263 <ul class="md-nav__list" data-md-scrollfix> 264 265 266 267 268 269 270 271 <li class="md-nav__item"> 272 <a href="../../Content/An-Overview/" title="An Overview" class="md-nav__link"> 273 An Overview 274 </a> 275 </li> 276 277 278 279 280 281 282 283 <li class="md-nav__item"> 284 <a href="../../Content/Extending-Content/" title="Extending Content" class="md-nav__link"> 285 Extending Content 286 </a> 287 </li> 288 289 290 </ul> 291 </nav> 292 </li> 293 294 295 296 297 298 299 300 <li class="md-nav__item md-nav__item--nested"> 301 302 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> 303 304 <label class="md-nav__link" for="nav-4"> 305 Form Fields 306 </label> 307 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 308 <label class="md-nav__title" for="nav-4"> 309 Form Fields 310 </label> 311 <ul class="md-nav__list" data-md-scrollfix> 312 313 314 315 316 317 318 319 <li class="md-nav__item"> 320 <a href="../../Form-Fields/HTML-Inputs/" title="HTML Inputs" class="md-nav__link"> 321 HTML Inputs 322 </a> 323 </li> 324 325 326 </ul> 327 </nav> 328 </li> 329 330 331 332 333 334 335 336 <li class="md-nav__item md-nav__item--nested"> 337 338 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> 339 340 <label class="md-nav__link" for="nav-5"> 341 HTTP APIs 342 </label> 343 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 344 <label class="md-nav__title" for="nav-5"> 345 HTTP APIs 346 </label> 347 <ul class="md-nav__list" data-md-scrollfix> 348 349 350 351 352 353 354 355 <li class="md-nav__item"> 356 <a href="../../HTTP-APIs/Content/" title="Content" class="md-nav__link"> 357 Content 358 </a> 359 </li> 360 361 362 363 364 365 366 367 <li class="md-nav__item"> 368 <a href="../../HTTP-APIs/File-Metadata/" title="File Metadata" class="md-nav__link"> 369 File Metadata 370 </a> 371 </li> 372 373 374 375 376 377 378 379 <li class="md-nav__item"> 380 <a href="../../HTTP-APIs/Search/" title="Search" class="md-nav__link"> 381 Search 382 </a> 383 </li> 384 385 386 </ul> 387 </nav> 388 </li> 389 390 391 392 393 394 395 396 <li class="md-nav__item md-nav__item--nested"> 397 398 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6"> 399 400 <label class="md-nav__link" for="nav-6"> 401 Interfaces 402 </label> 403 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 404 <label class="md-nav__title" for="nav-6"> 405 Interfaces 406 </label> 407 <ul class="md-nav__list" data-md-scrollfix> 408 409 410 411 412 413 414 415 <li class="md-nav__item"> 416 <a href="../../Interfaces/API/" title="API" class="md-nav__link"> 417 API 418 </a> 419 </li> 420 421 422 423 424 425 426 427 <li class="md-nav__item"> 428 <a href="../../Interfaces/Editor/" title="Editor" class="md-nav__link"> 429 Editor 430 </a> 431 </li> 432 433 434 435 436 437 438 439 <li class="md-nav__item"> 440 <a href="../../Interfaces/Format/" title="Format" class="md-nav__link"> 441 Format 442 </a> 443 </li> 444 445 446 447 448 449 450 451 <li class="md-nav__item"> 452 <a href="../../Interfaces/Item/" title="Item" class="md-nav__link"> 453 Item 454 </a> 455 </li> 456 457 458 459 460 461 462 463 <li class="md-nav__item"> 464 <a href="../../Interfaces/Search/" title="Search" class="md-nav__link"> 465 Search 466 </a> 467 </li> 468 469 470 </ul> 471 </nav> 472 </li> 473 474 475 476 477 478 479 480 <li class="md-nav__item md-nav__item--nested"> 481 482 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7"> 483 484 <label class="md-nav__link" for="nav-7"> 485 Ponzu Addons 486 </label> 487 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 488 <label class="md-nav__title" for="nav-7"> 489 Ponzu Addons 490 </label> 491 <ul class="md-nav__list" data-md-scrollfix> 492 493 494 495 496 497 498 499 <li class="md-nav__item"> 500 <a href="../../Ponzu-Addons/Creating-Addons/" title="Creating Addons" class="md-nav__link"> 501 Creating Addons 502 </a> 503 </li> 504 505 506 507 508 509 510 511 <li class="md-nav__item"> 512 <a href="../../Ponzu-Addons/Using-Addons/" title="Using Addons" class="md-nav__link"> 513 Using Addons 514 </a> 515 </li> 516 517 518 </ul> 519 </nav> 520 </li> 521 522 523 524 525 526 527 528 <li class="md-nav__item md-nav__item--nested"> 529 530 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8"> 531 532 <label class="md-nav__link" for="nav-8"> 533 Quickstart 534 </label> 535 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 536 <label class="md-nav__title" for="nav-8"> 537 Quickstart 538 </label> 539 <ul class="md-nav__list" data-md-scrollfix> 540 541 542 543 544 545 546 547 <li class="md-nav__item"> 548 <a href="../../Quickstart/Overview/" title="Overview" class="md-nav__link"> 549 Overview 550 </a> 551 </li> 552 553 554 </ul> 555 </nav> 556 </li> 557 558 559 560 561 562 563 564 <li class="md-nav__item md-nav__item--nested"> 565 566 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9"> 567 568 <label class="md-nav__link" for="nav-9"> 569 References 570 </label> 571 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 572 <label class="md-nav__title" for="nav-9"> 573 References 574 </label> 575 <ul class="md-nav__list" data-md-scrollfix> 576 577 578 579 580 581 582 583 <li class="md-nav__item"> 584 <a href="../../References/Overview/" title="Overview" class="md-nav__link"> 585 Overview 586 </a> 587 </li> 588 589 590 </ul> 591 </nav> 592 </li> 593 594 595 596 597 598 599 600 <li class="md-nav__item md-nav__item--nested"> 601 602 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10"> 603 604 <label class="md-nav__link" for="nav-10"> 605 Running Backups 606 </label> 607 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 608 <label class="md-nav__title" for="nav-10"> 609 Running Backups 610 </label> 611 <ul class="md-nav__list" data-md-scrollfix> 612 613 614 615 616 617 618 619 <li class="md-nav__item"> 620 <a href="../../Running-Backups/Backups/" title="Backups" class="md-nav__link"> 621 Backups 622 </a> 623 </li> 624 625 626 </ul> 627 </nav> 628 </li> 629 630 631 632 633 634 635 636 637 638 <li class="md-nav__item md-nav__item--active md-nav__item--nested"> 639 640 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11" checked> 641 642 <label class="md-nav__link" for="nav-11"> 643 System Configuration 644 </label> 645 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 646 <label class="md-nav__title" for="nav-11"> 647 System Configuration 648 </label> 649 <ul class="md-nav__list" data-md-scrollfix> 650 651 652 653 654 655 656 657 658 659 <li class="md-nav__item md-nav__item--active"> 660 661 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc"> 662 663 664 <label class="md-nav__link md-nav__link--active" for="toc"> 665 Settings 666 </label> 667 668 <a href="./" title="Settings" class="md-nav__link md-nav__link--active"> 669 Settings 670 </a> 671 672 673 <nav class="md-nav md-nav--secondary"> 674 675 676 677 <label class="md-nav__title" for="toc">Table of contents</label> 678 <ul class="md-nav__list" data-md-scrollfix> 679 680 <li class="md-nav__item"> 681 <a href="#site-name" title="Site Name" class="md-nav__link"> 682 Site Name 683 </a> 684 685 </li> 686 687 <li class="md-nav__item"> 688 <a href="#domain-name" title="Domain Name" class="md-nav__link"> 689 Domain Name 690 </a> 691 692 <nav class="md-nav"> 693 <ul class="md-nav__list"> 694 695 <li class="md-nav__item"> 696 <a href="#development-environment" title="Development Environment" class="md-nav__link"> 697 Development Environment 698 </a> 699 700 </li> 701 702 </ul> 703 </nav> 704 705 </li> 706 707 <li class="md-nav__item"> 708 <a href="#administrator-email" title="Administrator Email" class="md-nav__link"> 709 Administrator Email 710 </a> 711 712 </li> 713 714 <li class="md-nav__item"> 715 <a href="#client-secret" title="Client Secret" class="md-nav__link"> 716 Client Secret 717 </a> 718 719 </li> 720 721 <li class="md-nav__item"> 722 <a href="#etag-header" title="Etag Header" class="md-nav__link"> 723 Etag Header 724 </a> 725 726 </li> 727 728 <li class="md-nav__item"> 729 <a href="#cors" title="CORS" class="md-nav__link"> 730 CORS 731 </a> 732 733 </li> 734 735 <li class="md-nav__item"> 736 <a href="#gzip" title="GZIP" class="md-nav__link"> 737 GZIP 738 </a> 739 740 </li> 741 742 <li class="md-nav__item"> 743 <a href="#http-cache" title="HTTP Cache" class="md-nav__link"> 744 HTTP Cache 745 </a> 746 747 </li> 748 749 <li class="md-nav__item"> 750 <a href="#invalidate-cache" title="Invalidate Cache" class="md-nav__link"> 751 Invalidate Cache 752 </a> 753 754 </li> 755 756 <li class="md-nav__item"> 757 <a href="#database-backup-credentials" title="Database Backup Credentials" class="md-nav__link"> 758 Database Backup Credentials 759 </a> 760 761 </li> 762 763 764 765 </ul> 766 767 </nav> 768 769 </li> 770 771 772 </ul> 773 </nav> 774 </li> 775 776 777 778 779 780 781 782 <li class="md-nav__item md-nav__item--nested"> 783 784 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12"> 785 786 <label class="md-nav__link" for="nav-12"> 787 System Deployment 788 </label> 789 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 790 <label class="md-nav__title" for="nav-12"> 791 System Deployment 792 </label> 793 <ul class="md-nav__list" data-md-scrollfix> 794 795 796 797 798 799 800 801 <li class="md-nav__item"> 802 <a href="../../System-Deployment/Docker/" title="Docker" class="md-nav__link"> 803 Docker 804 </a> 805 </li> 806 807 808 809 810 811 812 813 <li class="md-nav__item"> 814 <a href="../../System-Deployment/SysV-Style/" title="SysV Style" class="md-nav__link"> 815 SysV Style 816 </a> 817 </li> 818 819 820 </ul> 821 </nav> 822 </li> 823 824 825 </ul> 826 </nav> 827 </div> 828 </div> 829 </div> 830 831 832 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> 833 <div class="md-sidebar__scrollwrap"> 834 <div class="md-sidebar__inner"> 835 836 <nav class="md-nav md-nav--secondary"> 837 838 839 840 <label class="md-nav__title" for="toc">Table of contents</label> 841 <ul class="md-nav__list" data-md-scrollfix> 842 843 <li class="md-nav__item"> 844 <a href="#site-name" title="Site Name" class="md-nav__link"> 845 Site Name 846 </a> 847 848 </li> 849 850 <li class="md-nav__item"> 851 <a href="#domain-name" title="Domain Name" class="md-nav__link"> 852 Domain Name 853 </a> 854 855 <nav class="md-nav"> 856 <ul class="md-nav__list"> 857 858 <li class="md-nav__item"> 859 <a href="#development-environment" title="Development Environment" class="md-nav__link"> 860 Development Environment 861 </a> 862 863 </li> 864 865 </ul> 866 </nav> 867 868 </li> 869 870 <li class="md-nav__item"> 871 <a href="#administrator-email" title="Administrator Email" class="md-nav__link"> 872 Administrator Email 873 </a> 874 875 </li> 876 877 <li class="md-nav__item"> 878 <a href="#client-secret" title="Client Secret" class="md-nav__link"> 879 Client Secret 880 </a> 881 882 </li> 883 884 <li class="md-nav__item"> 885 <a href="#etag-header" title="Etag Header" class="md-nav__link"> 886 Etag Header 887 </a> 888 889 </li> 890 891 <li class="md-nav__item"> 892 <a href="#cors" title="CORS" class="md-nav__link"> 893 CORS 894 </a> 895 896 </li> 897 898 <li class="md-nav__item"> 899 <a href="#gzip" title="GZIP" class="md-nav__link"> 900 GZIP 901 </a> 902 903 </li> 904 905 <li class="md-nav__item"> 906 <a href="#http-cache" title="HTTP Cache" class="md-nav__link"> 907 HTTP Cache 908 </a> 909 910 </li> 911 912 <li class="md-nav__item"> 913 <a href="#invalidate-cache" title="Invalidate Cache" class="md-nav__link"> 914 Invalidate Cache 915 </a> 916 917 </li> 918 919 <li class="md-nav__item"> 920 <a href="#database-backup-credentials" title="Database Backup Credentials" class="md-nav__link"> 921 Database Backup Credentials 922 </a> 923 924 </li> 925 926 927 928 </ul> 929 930 </nav> 931 </div> 932 </div> 933 </div> 934 935 936 <div class="md-content"> 937 <article class="md-content__inner md-typeset"> 938 939 940 941 <h1>Settings</h1> 942 943 <p>Ponzu has several options which can be configured at run-time. To view these 944 configuration settings, visit the <code>/admin/configure</code> page of your Ponzu CMS.</p> 945 <hr /> 946 <h4 id="site-name">Site Name<a class="headerlink" href="#site-name" title="Permanent link">¶</a></h4> 947 <p>The Site Name setting changes the displayed name on your admin dashboard. This is 948 visible publicly on the <code>/admin/login</code> page.</p> 949 <hr /> 950 <h4 id="domain-name">Domain Name<a class="headerlink" href="#domain-name" title="Permanent link">¶</a></h4> 951 <p>Internally, Ponzu needs to know where its canonical HTTP access origin is, and 952 requires you to add the qualified domain name you are using. In development, use 953 <code>localhost</code> or some other name mapped to the loopback address (<code>127.0.0.1</code>).</p> 954 <p>Once you have deployed your Ponzu server to a remote host and pointed a public 955 domain at it, you need to change the Domain Name setting to match. This is 956 especially important when fetching TLS (SSL) certificates from <a href="https://letsencrypt.org">Let's Encrypt</a> 957 - since the process requires an active, verifiable domain. To set up your server 958 with TLS over HTTPS connections, follow these steps:</p> 959 <ol> 960 <li>Set your Domain Name in the system configuration</li> 961 <li>Set the Administrator Email to register with Let's Encrypt</li> 962 <li>Stop your Ponzu server</li> 963 <li>Run your Ponzu server with the <code>--https</code> flag e.g. <code>$ ponzu run --https</code></li> 964 <li>Visit your CMS admin with <code>https://</code> prepended to your URL</li> 965 </ol> 966 <div class="admonition success"> 967 <p class="admonition-title">Verifying HTTPS / TLS Connections</p> 968 <p>If successful, your APIs and CMS will be accessible via HTTPS, and you will 969 see a green indicator near the URL bar of most browsers. This also enables 970 your server to use the HTTP/2 protocol.</p> 971 </div> 972 <h5 id="development-environment">Development Environment<a class="headerlink" href="#development-environment" title="Permanent link">¶</a></h5> 973 <p>You can test HTTPS & HTTP/2 connections in your development environment on <code>localhost</code>, 974 by running Ponzu with the <code>--devhttps</code> flag e.g. <code>$ ponzu --devhttps run</code> </p> 975 <p>If you're greeted with a warning from the browser saying the connection is not 976 secure, follow the steps outlined in the CLI message, or here:</p> 977 <div class="codehilite"><pre><span></span>If your browser rejects HTTPS requests, try allowing insecure connections on localhost. 978 on Chrome, visit chrome://flags/#allow-insecure-localhost 979 </pre></div> 980 981 982 <hr /> 983 <h4 id="administrator-email">Administrator Email<a class="headerlink" href="#administrator-email" title="Permanent link">¶</a></h4> 984 <p>The Administrator Email is the contact email for the person who is the main admin 985 of your Ponzu CMS. This can be changed at any point, but once a Let's Encrypt 986 certificate has been fetched using an Administrator Email, it will remain the 987 contact until a new certificate is requested. </p> 988 <hr /> 989 <h4 id="client-secret">Client Secret<a class="headerlink" href="#client-secret" title="Permanent link">¶</a></h4> 990 <p>The Client Secret is a secure value used by the server to sign tokens and authenticate requests. 991 <strong>Do not share this</strong> value with any untrusted party.</p> 992 <div class="admonition danger"> 993 <p class="admonition-title">Security and the Client Secret</p> 994 <p>HTTP requests with a valid token, signed with the Client Secret, can take any 995 action an Admin can within the CMS. Be cautious of this when sharing account 996 logins or details with anyone.</p> 997 </div> 998 <hr /> 999 <h4 id="etag-header">Etag Header<a class="headerlink" href="#etag-header" title="Permanent link">¶</a></h4> 1000 <p>The Etag Header value is automatically created when content is changed and serves 1001 as a caching validation mechanism.</p> 1002 <hr /> 1003 <h4 id="cors">CORS<a class="headerlink" href="#cors" title="Permanent link">¶</a></h4> 1004 <p>CORS, or "Cross-Origin Resource Sharing" is a security setting which defines how 1005 resources (or URLs) can be accessed from outside clients / domains. By default, 1006 Ponzu HTTP APIs can be accessed from any origin, meaning a script from an unknown 1007 website could fetch data. </p> 1008 <p>By disabling CORS, you limit API requests to only the Domain Name you set.</p> 1009 <hr /> 1010 <h4 id="gzip">GZIP<a class="headerlink" href="#gzip" title="Permanent link">¶</a></h4> 1011 <p>GZIP is a popular codec which when applied to most HTTP responses, decreases data 1012 transmission size and response times. The GZIP setting on Ponzu has a minor 1013 side-effect of using more CPU, so you can disable it if you notice your system 1014 is CPU-constrained. However, traffic levels would need to be extremely demanding 1015 for this to be noticeable.</p> 1016 <hr /> 1017 <h4 id="http-cache">HTTP Cache<a class="headerlink" href="#http-cache" title="Permanent link">¶</a></h4> 1018 <p>The HTTP Cache configuration allows a system to disable the default HTTP cache, 1019 which saves the server from repeating API queries and sending responses -- it's 1020 generally advised to keep this enabled unless you have <em>frequently</em> changing data.</p> 1021 <p>The <code>Max-Age</code> value setting overrides the default 2592000-second (30 day) cache 1022 <code>max-age</code> duration set in API response headers. The <code>0</code> value is an alias to 1023 <code>2592000</code>, so check the <code>Disable HTTP Cache</code> box if you don't want any caching.</p> 1024 <hr /> 1025 <h4 id="invalidate-cache">Invalidate Cache<a class="headerlink" href="#invalidate-cache" title="Permanent link">¶</a></h4> 1026 <p>If this box is checked and then the configuration is saved, the server will 1027 re-generate an Etag to send in responses. By doing so, the cache becomes invalidated 1028 and reset so new content or assets will be included in previously cached responses.</p> 1029 <p>The cache is invalidated when content changes, so this is typically not a widely 1030 used setting.</p> 1031 <hr /> 1032 <h4 id="database-backup-credentials">Database Backup Credentials<a class="headerlink" href="#database-backup-credentials" title="Permanent link">¶</a></h4> 1033 <p>In order to enable HTTP backups of the components that make up your system, you 1034 will need to add an HTTP Basic Auth user and password pair. When used to 1035 <a href="../../Running-Backups/Backups">run backups</a>, the <code>user:password</code> pair tells your server 1036 that the backup request is made from a trusted party. </p> 1037 <div class="admonition danger"> 1038 <p class="admonition-title">Backup Access with Credentials</p> 1039 <p>This <code>user:password</code> pair should not be shared outside of your organization as 1040 it allows full database downloads and archives of your system's uploads.</p> 1041 </div> 1042 1043 1044 1045 1046 1047 1048 1049 </article> 1050 </div> 1051 </div> 1052 </main> 1053 1054 1055 <footer class="md-footer"> 1056 1057 <div class="md-footer-nav"> 1058 <nav class="md-footer-nav__inner md-grid"> 1059 1060 <a href="../../Running-Backups/Backups/" title="Backups" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> 1061 <div class="md-flex__cell md-flex__cell--shrink"> 1062 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> 1063 </div> 1064 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> 1065 <span class="md-flex__ellipsis"> 1066 <span class="md-footer-nav__direction"> 1067 Previous 1068 </span> 1069 Backups 1070 </span> 1071 </div> 1072 </a> 1073 1074 1075 <a href="../../System-Deployment/Docker/" title="Docker" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> 1076 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> 1077 <span class="md-flex__ellipsis"> 1078 <span class="md-footer-nav__direction"> 1079 Next 1080 </span> 1081 Docker 1082 </span> 1083 </div> 1084 <div class="md-flex__cell md-flex__cell--shrink"> 1085 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> 1086 </div> 1087 </a> 1088 1089 </nav> 1090 </div> 1091 1092 <div class="md-footer-meta md-typeset"> 1093 <div class="md-footer-meta__inner md-grid"> 1094 <div class="md-footer-copyright"> 1095 1096 powered by 1097 <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a> 1098 and 1099 <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs"> 1100 Material for MkDocs</a> 1101 </div> 1102 1103 1104 <div class="md-footer-social"> 1105 1106 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> 1107 1108 <a href="https://github.com/ponzu-cms" class="md-footer-social__link fa fa-github"></a> 1109 1110 <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> 1111 1112 </div> 1113 1114 1115 </div> 1116 </div> 1117 </footer> 1118 1119 </div> 1120 1121 <script src="../../assets/javascripts/application-6b599127bc.js"></script> 1122 <script>app.initialize({url:{base:"../.."}})</script> 1123 1124 1125 1126 1127 <script>!function(e,t,a,n,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(a),i=t.getElementsByTagName(a)[0],c.async=1,c.src=n,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-98609560-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})});var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script> 1128 1129 1130 </body> 1131 </html>